diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5dd1ca3..c1c8493 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,13 +18,12 @@ jobs: with: python-version: "3.x" - name: Install dependencies - run: pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints myst-parser - - name: Generate Class List - run: | - pip install . - python ./docs/source/generate_class_list.py + run: pip install .[doc_build] + - name: Generate Examples + run: python ./docs/source/generate_class_list.py - name: Build Docs run: | + cp LICENSE docs/source/LICENSE.md cd docs sphinx-apidoc -o ./source/ ../src/ -M --no-toc rm ./source/*.rst diff --git a/docs/source/conf.py b/docs/source/conf.py index 5a66dac..6bb430b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,7 +26,7 @@ exclude_patterns = [] # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # html_theme = 'alabaster' -html_theme = 'sphinx_rtd_theme' +html_theme = 'pydata_sphinx_theme' html_static_path = ['_static'] autodoc_inherit_docstrings = True diff --git a/pyproject.toml b/pyproject.toml index 60e59f3..5116a3f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,6 +28,12 @@ where = ["src"] dev = [ "pytest", "flake8", "mypy" ] +doc_build = [ + "sphinx", + "pydata_sphinx_theme", + "sphinx-autodoc-typehints", + "myst-parser" +] [tool.mypy] files = ["src", "tests"]