Open lili7h opened 1 month ago
Add sphinx auto-doc generator to allow us to easily make html/web pages using the python pydoc comments
Supports both google style and reStructuredText style
Adds the various related sphinx python requirements to the dev dependencies of pdm.
pdm
Run with pdm run sphinx-build docs/source docs/build
pdm run sphinx-build docs/source docs/build
You can view by running a python http server from the docs/build folder. I.e. cd docs/build/ && python -m http.server
docs/build
cd docs/build/ && python -m http.server
Add sphinx auto-doc generator to allow us to easily make html/web pages using the python pydoc comments
Supports both google style and reStructuredText style
Adds the various related sphinx python requirements to the dev dependencies of
pdm.Run with
pdm run sphinx-build docs/source docs/buildYou can view by running a python http server from the
docs/buildfolder. I.e.cd docs/build/ && python -m http.server