Skip to content

Commit a93ebd0

Browse files
Josverldpgeorge
authored andcommitted
docs: Add requirements.txt file with dependencies for Sphinx.
Signed-off-by: Jos Verlinde <[email protected]>
1 parent da193c4 commit a93ebd0

File tree

3 files changed

+4
-2
lines changed

3 files changed

+4
-2
lines changed

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ jobs:
1717
- uses: actions/checkout@v4
1818
- uses: actions/setup-python@v4
1919
- name: Install Python packages
20-
run: pip install Sphinx
20+
run: pip install -r docs/requirements.txt
2121
- name: Build docs
2222
run: make -C docs/ html

docs/develop/gettingstarted.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ that you use a virtual environment:
245245
246246
$ python3 -m venv env
247247
$ source env/bin/activate
248-
$ pip install sphinx
248+
$ pip install -r docs/requirements.txt
249249
250250
Navigate to the ``docs`` directory:
251251

docs/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
sphinx~=7.2.6
2+
sphinxcontrib.jquery==4.1

0 commit comments

Comments
 (0)