mirror of https://github.com/Nonannet/pelfy.git
docs build process updated
This commit is contained in:
parent
c6682effc7
commit
ca1dbbdf2e
|
@ -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
|
||||
|
|
|
@ -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
|
||||
|
|
|
@ -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"]
|
||||
|
|
Loading…
Reference in New Issue