7.1.4.1. Main documentation¶
This documentation is under the docs
directory of the Numba repository.
It is built with Sphinx and
numpydoc, which are available using
conda or pip; i.e. conda install sphinx numpydoc
.
To build the documentation, you need the bootstrap theme:
$ pip install sphinx_bootstrap_theme
You can edit the source files under docs/source/
, after which you can
build and check the documentation:
$ make html
$ open _build/html/index.html
Core developers can upload this documentation to the Numba website
at http://numba.pydata.org by using the gh-pages.py
script under docs
:
$ python gh-pages.py version # version can be 'dev' or '0.16' etc
then verify the repository under the gh-pages
directory and use
git push
.