Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

developer contributing docs - llvm, sqlite3, sphinx-rtd-theme, and make html #7367

Closed
wants to merge 10 commits into from
13 changes: 7 additions & 6 deletions docs/source/developer/contributing.rst
Expand Up @@ -91,10 +91,11 @@ recommend you use `conda <http://conda.pydata.org/miniconda.html>`_ to
create a dedicated development environment and install precompiled versions
of those dependencies there.

First add the Anaconda Cloud ``numba`` channel so as to get development builds
of the llvmlite library::
First add the Anaconda Cloud ``numba`` and ``numba/label/dev``
channels so as to get development builds of the llvmlite library::

$ conda config --add channels numba
$ conda config --add channels numba/label/dev

Then create an environment with the right dependencies::

Expand All @@ -118,7 +119,7 @@ Once the environment is activated, you have a dedicated Python with the
required dependencies::

$ python
Python 3.8.5 (default, Sep 4 2020, 07:30:14)
Python 3.8.5 (default, Sep 4 2020, 07:30:14)
[GCC 7.3.0] :: Anaconda, Inc. on linux
Type "help", "copyright", "credits" or "license" for more information.

Expand Down Expand Up @@ -415,12 +416,12 @@ It is built with `Sphinx <http://sphinx-doc.org/>`_ and
`numpydoc <https://numpydoc.readthedocs.io/>`_, which are available using
conda or pip; i.e. ``conda install sphinx numpydoc``.

To build the documentation, you need the bootstrap theme::
To build the documentation, you need the rtd theme::

$ pip install sphinx_bootstrap_theme
$ conda install sphinx-rtd-theme
sgbaird marked this conversation as resolved.
Show resolved Hide resolved

You can edit the source files under ``docs/source/``, after which you can
build and check the documentation::
build and check the documentation under ``docs/``::

$ make html
$ open _build/html/index.html
Expand Down