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 13 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
17 changes: 9 additions & 8 deletions docs/source/developer/contributing.rst
Expand Up @@ -92,8 +92,9 @@ 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>`_.


Then, to create an environment with a few of the most common dependencies::
Then, to create an environment with a few of the most common dependencies. Note
the use of the double-colon syntax (``numba/label/dev::llvmlite``) to install
the latest development version of the llvmlite library.
esc marked this conversation as resolved.
Show resolved Hide resolved

$ conda create -n numbaenv python=3.10 numba/label/dev::llvmlite numpy scipy jinja2 cffi

Expand Down Expand Up @@ -461,16 +462,16 @@ Main documentation
''''''''''''''''''

This documentation is under the ``docs`` directory of the `Numba repository`_.
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``.
It is built with `Sphinx <http://sphinx-doc.org/>`_, `numpydoc
<https://numpydoc.readthedocs.io/>`_ and the `sphinx-rtd-theme
<https://sphinx-rtd-theme.readthedocs.io/en/stable/>`.
esc marked this conversation as resolved.
Show resolved Hide resolved

To build the documentation, you need the bootstrap theme::
To install all dependencies for building the documentation, use::

$ pip install sphinx_bootstrap_theme
$ conda install sphinx numpydoc 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