https://github.com/taichi-dev/docstring-gen
Workflow for generating the docstring website
https://github.com/taichi-dev/docstring-gen
Last synced: about 1 year ago
JSON representation
Workflow for generating the docstring website
- Host: GitHub
- URL: https://github.com/taichi-dev/docstring-gen
- Owner: taichi-dev
- Created: 2021-07-24T15:16:36.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-08T02:51:07.000Z (about 3 years ago)
- Last Synced: 2025-05-06T18:14:48.743Z (about 1 year ago)
- Language: Python
- Size: 43 KB
- Stars: 4
- Watchers: 7
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
We use the Sphinx toolchain to transform the Python docstrings into HTMLs. This is as simple as:
1. Set `TAICHI_PATH` to the root of the Taichi repo.
2. Run the following:
```sh
pip install -r requirements.txt
cd experimental/
make html
```
3. Then go to `_build/html` and open `index.html` in your browser, i.e. `open _build/html/index.html`.
# References
* [sphinx-autodoc](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html): This extension can import the modules you are documenting, and pull in documentation from docstrings in a semi-automatic way.
* [sphinx.ext.napoleon](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html): This is for parsing the Google-style (Numpy-style as well) Python docstring.
* [sphinx-rtd-theme](https://sphinx-rtd-theme.readthedocs.io/en/stable/): Additional Sphinx themes.
* [sphinx-autoapi](https://github.com/readthedocs/sphinx-autoapi): "real" auto-generation of APIs.