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

Update dev-docs #8730

Merged
merged 16 commits into from May 4, 2023
Merged
Changes from 11 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/source/developer/contributing.rst
Expand Up @@ -92,6 +92,11 @@ When working with a source checkout of Numba you will also need a development
build of llvmlite. These are available from the ``numba/label/dev`` channel on
`anaconda.org <https://anaconda.org/numba/llvmlite>`_.

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, to create an environment with a few of the most common dependencies::

Expand Down Expand Up @@ -465,12 +470,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

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