Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/source/contributing/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,20 @@ Add the following to your VSCode ``settings.json``:

-------------------------------------------------------------------------------

Contributing to the docs
------------------------

The docs are written using Sphinx. To get them running locally:

* Make sure the main requirements are installed: ``pip install -r requirements/requirements.txt``
* Install the documentation requirements: ``pip install -r requirements/doc-requirements.txt``
* ``cd docs``
* Do an initial build of the docs: ``make html``
* Serve the docs: ``python serve_docs.py``
* The docs will auto rebuild as you make changes.

-------------------------------------------------------------------------------

Storybook
---------

Expand Down
Loading