docs: Add requirements.txt file with dependencies for Sphinx.

Signed-off-by: Jos Verlinde <Jos.Verlinde@Microsoft.com>
micropython · Oct 2, 2023 · a93ebd0 · a93ebd0
1 parent da193c4
commit a93ebd0
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 2 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -17,6 +17,6 @@ jobs:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v4
     - name: Install Python packages
-      run: pip install Sphinx
+      run: pip install -r docs/requirements.txt
     - name: Build docs
       run: make -C docs/ html
diff --git a/docs/develop/gettingstarted.rst b/docs/develop/gettingstarted.rst
@@ -245,7 +245,7 @@ that you use a virtual environment:
 
    $ python3 -m venv env
    $ source env/bin/activate
-   $ pip install sphinx
+   $ pip install -r docs/requirements.txt
 
 Navigate to the ``docs`` directory:
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,2 @@
+sphinx~=7.2.6
+sphinxcontrib.jquery==4.1