From 8cb12c001ab941900dd842ad09c5922bfa4883b0 Mon Sep 17 00:00:00 2001
From: Jonas Heinle <jonasheinle@googlemail.com>
Date: Mon, 15 Jul 2024 08:04:38 +0200
Subject: [PATCH] added support for sphinx

---
 .vscode/tasks.json                            | 27 ++++++++++++++
 README.md                                     |  4 ++-
 docs/Makefile                                 | 20 +++++++++++
 docs/make.bat                                 | 35 ++++++++++++++++++
 docs/source/conf.py                           | 36 +++++++++++++++++++
 docs/source/index.rst                         | 26 ++++++++++++++
 docs/source/webdavclient.rst                  |  7 ++++
 pyproject.toml                                |  8 ++---
 .../{dev_requirements.txt => dev.txt}         |  1 +
 requirements/docs.txt                         |  1 +
 10 files changed, 160 insertions(+), 5 deletions(-)
 create mode 100644 .vscode/tasks.json
 create mode 100644 docs/Makefile
 create mode 100644 docs/make.bat
 create mode 100644 docs/source/conf.py
 create mode 100644 docs/source/index.rst
 create mode 100644 docs/source/webdavclient.rst
 rename requirements/{dev_requirements.txt => dev.txt} (64%)
 create mode 100644 requirements/docs.txt

diff --git a/.vscode/tasks.json b/.vscode/tasks.json
new file mode 100644
index 0000000..59365a5
--- /dev/null
+++ b/.vscode/tasks.json
@@ -0,0 +1,27 @@
+{
+	// See https://go.microsoft.com/fwlink/?LinkId=733558
+	// for the documentation about the tasks.json format
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"label": "Run Bandit",
+			"type": "shell",
+			"command": "bandit",
+			"args": [
+				"-r",
+				"--exclude",
+				"venv,env",
+				"."
+			],
+			"problemMatcher": [],
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"presentation": {
+				"reveal": "always",
+				"panel": "shared"
+			}
+		}
+	]
+}
\ No newline at end of file
diff --git a/README.md b/README.md
index fede070..aa8841e 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,9 @@
   <a href="https://jonasheinle.de"><img src="images/glm_logo.png" alt="VulkanEngine" width="200"></a>
 </h1> -->
 
-<h4 align="center">Download files via webdav easily <a href="https://jonasheinle.de" target="_blank"></a>.</h4>
+<h4 align="center">Download files via webdav easily. Use it to communicate to cloud storage provider (e.g. Nextcloud, ownCloud, Magenta, Synology NAS,
+QNAPS NAS) and automate your personal storage tasks.
+ <a href="https://jonasheinle.de" target="_blank"></a>.</h4>
 
 <!-- [![Linux build](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Linux.yml/badge.svg)](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Linux.yml)
 [![Windows build](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Windows.yml/badge.svg)](https://github.com/Kataglyphis/GraphicsEngineVulkan/actions/workflows/Windows.yml)
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..dc1312a
--- /dev/null
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..ad7adf0
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,36 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../../"))
+
+project = "WebDavClient"
+copyright = "2024, Jonas Heinle"
+author = "Jonas Heinle"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",  # For Google and NumPy style docstrings
+    "sphinx.ext.viewcode",  # To include links to the source code
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "alabaster"
+html_static_path = ["_static"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..356489d
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,26 @@
+.. WebDavClient documentation master file, created by
+   sphinx-quickstart on Mon Jul 15 07:27:38 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+WebDavClient documentation
+==========================
+
+Add your content using ``reStructuredText`` syntax. See the
+`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
+documentation for details.
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   webdavclient
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
diff --git a/docs/source/webdavclient.rst b/docs/source/webdavclient.rst
new file mode 100644
index 0000000..63df4d1
--- /dev/null
+++ b/docs/source/webdavclient.rst
@@ -0,0 +1,7 @@
+WebDavClient
+============
+
+.. automodule:: webdavclient
+    :members:
+    :undoc-members:
+    :show-inheritance:
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 073d926..a284794 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -16,12 +16,12 @@ authors = [
 ]
 description = "This package contains modules to easily communicate to a host via WebDav."
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 keywords=["webdav", "cloud"]
 classifiers = [
     "Development Status :: 1 - Production/Stable",
     "Operating System :: OS Independent",
-    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.11",
 ]
 
 dependencies=["loguru","requests"]
@@ -31,10 +31,10 @@ Homepage = "https://github.com/Kataglyphis/WebDavClient"
 
 [tool.black]
 line-length = 88
-target-version = ['py312']
+target-version = ['py311']
 
 [tool.mypy]
-python_version = "3.12"
+python_version = "3.11"
 warn_return_any = true
 warn_unused_configs = true
 exclude = [
diff --git a/requirements/dev_requirements.txt b/requirements/dev.txt
similarity index 64%
rename from requirements/dev_requirements.txt
rename to requirements/dev.txt
index f20b15c..c25ed3d 100644
--- a/requirements/dev_requirements.txt
+++ b/requirements/dev.txt
@@ -1,2 +1,3 @@
 black
 mypy
+bandit
\ No newline at end of file
diff --git a/requirements/docs.txt b/requirements/docs.txt
new file mode 100644
index 0000000..1b3a6e8
--- /dev/null
+++ b/requirements/docs.txt
@@ -0,0 +1 @@
+sphinx
\ No newline at end of file