From 8f7ad5c6d7f60942b20d56702a49d8020e421ecb Mon Sep 17 00:00:00 2001 From: Jonas Heinle Date: Tue, 16 Jul 2024 19:01:08 +0200 Subject: [PATCH] deploy website --- .github/workflows/pages.yml | 3 ++- docs/source/conf.py | 7 +++++++ requirements/docs.txt | 3 ++- webdavclient/__init__.py | 2 +- 4 files changed, 12 insertions(+), 3 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 175ffbc..31184b4 100644 --- a/.github/workflows/pages.yml +++ b/.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/" diff --git a/docs/source/conf.py b/docs/source/conf.py index ad7adf0..5b87b6f 100644 --- a/docs/source/conf.py +++ b/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", +} diff --git a/requirements/docs.txt b/requirements/docs.txt index 1b3a6e8..b17e024 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1 +1,2 @@ -sphinx \ No newline at end of file +sphinx +recommonmark \ No newline at end of file diff --git a/webdavclient/__init__.py b/webdavclient/__init__.py index 789ebed..b8952b2 100644 --- a/webdavclient/__init__.py +++ b/webdavclient/__init__.py @@ -1,3 +1,3 @@ from .webdavclient import WebDavClient -__all__ = ["WebDavClient"] +__all__: list[str] = ["WebDavClient"]