Doc#
auto generate from code
sphinx-apidoc -f -o docs/ codeforces_core/
This will force overwriting
Generate static html doc#
cd docs
make html
The output file is at ./docs/_build/html/
Live doc#
cd docs && make clean && cd .. && sphinx-apidoc -f -o docs/ codeforces_core/ && cd docs && make html && cd ..
rst Examples#
https://docutils.sourceforge.io/docs/user/rst/quickstart.html
https://docutils.sourceforge.io/docs/user/rst/quickref.html
https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#module-sphinx.ext.autodoc
rst py function:
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-py-function