From ba36810eaf3ed43235d9a973c96e5807e9ba6784 Mon Sep 17 00:00:00 2001 From: sinisaos Date: Thu, 30 Oct 2025 20:22:32 +0100 Subject: [PATCH 1/2] adds a guide to contributing documents --- docs/source/contributing/index.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/source/contributing/index.rst b/docs/source/contributing/index.rst index 3b281fce..8d7ca44c 100644 --- a/docs/source/contributing/index.rst +++ b/docs/source/contributing/index.rst @@ -108,6 +108,19 @@ Add the following to your VSCode ``settings.json``: ------------------------------------------------------------------------------- +Contributing to the docs +------------------------ + +The docs are written using Sphinx. To get them running locally: + +* Install the requirements: ``pip install -r requirements/readthedocs-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 --------- From 745f57686224727f9fa94db15988259e85920e19 Mon Sep 17 00:00:00 2001 From: sinisaos Date: Wed, 17 Dec 2025 09:05:19 +0100 Subject: [PATCH 2/2] add @dantownsend suggestions --- docs/source/contributing/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/source/contributing/index.rst b/docs/source/contributing/index.rst index 8d7ca44c..5d8388f3 100644 --- a/docs/source/contributing/index.rst +++ b/docs/source/contributing/index.rst @@ -113,7 +113,8 @@ Contributing to the docs The docs are written using Sphinx. To get them running locally: -* Install the requirements: ``pip install -r requirements/readthedocs-requirements.txt`` +* 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``