deploy website

.github/workflows/pages.yml

@@ -24,6 +24,7 @@ jobs:
       - name: Setup python env
         run: |
           pip install -v -e .
+          pip install -r requirements/docs.txt
       - name : Build web page
         run: |
           cd docs/build
@@ -33,5 +34,5 @@ jobs:
         with:
           server: ${{ secrets.SERVER }}
           username: ${{ secrets.USERNAME }}
-          password: ${{ secrets.DEV_PW }}
+          password: ${{ secrets.PASSWORD }}
           local-dir: "./docs/build/html/"

docs/source/conf.py

@@ -23,6 +23,7 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",  # For Google and NumPy style docstrings
     "sphinx.ext.viewcode",  # To include links to the source code
+    "myst_parser",  # adding .md files
 ]
 
 templates_path = ["_templates"]
@@ -34,3 +35,9 @@
 
 html_theme = "alabaster"
 html_static_path = ["_static"]
+
+# Enable the processing of Markdown files
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}

requirements/docs.txt

@@ -1 +1,2 @@
-sphinx
+sphinx
+recommonmark

webdavclient/__init__.py

@@ -1,3 +1,3 @@
 from .webdavclient import WebDavClient
 
-__all__ = ["WebDavClient"]
+__all__: list[str] = ["WebDavClient"]