Extract the API documentation stubs with the tool sphinx-apidoc and generate the HTML documentation with the tool sphinx-build. To generate the documentation run make docs in the project root. It is put in the directory ./docs/html. I added ./docs/source and ./docs/html to .gitignore; the former is generated by sphinx-apidoc and the latter by sphinx-build.
Extract the API documentation stubs with the tool
sphinx-apidoc
and generate the HTML documentation with the toolsphinx-build
. To generate the documentation runmake docs
in the project root. It is put in the directory./docs/html
. I added./docs/source
and./docs/html
to.gitignore
; the former is generated bysphinx-apidoc
and the latter bysphinx-build
.Related to #2