cd docs
# auto generate api rst
sphinx-apidoc -f -o source -H pyEdgeEval ../pyEdgeEval/
# geneate html
make html
# check html
python -m http.server --directory build/html 8889
# update gh-pages
make update-gh-pages
TODO:
- basic workflow
- workflow for documenting APIs (automatic parsing of docstrings)
- docstrings for cython
NOTES:
- use Google Python Style Guide (
sphinx.ext.napoleon
) - sphinx guides: