Skip to content

Commit ba36810

Browse files
committed
adds a guide to contributing documents
1 parent 55c3ec7 commit ba36810

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/source/contributing/index.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,19 @@ Add the following to your VSCode ``settings.json``:
108108
109109
-------------------------------------------------------------------------------
110110

111+
Contributing to the docs
112+
------------------------
113+
114+
The docs are written using Sphinx. To get them running locally:
115+
116+
* Install the requirements: ``pip install -r requirements/readthedocs-requirements.txt``
117+
* ``cd docs``
118+
* Do an initial build of the docs: ``make html``
119+
* Serve the docs: ``python serve_docs.py``
120+
* The docs will auto rebuild as you make changes.
121+
122+
-------------------------------------------------------------------------------
123+
111124
Storybook
112125
---------
113126

0 commit comments

Comments
 (0)