From a93ebd0e0368a44f92322d0dbf45bab49165a891 Mon Sep 17 00:00:00 2001 From: Jos Verlinde Date: Fri, 22 Sep 2023 18:00:36 +0000 Subject: [PATCH] docs: Add requirements.txt file with dependencies for Sphinx. Signed-off-by: Jos Verlinde --- .github/workflows/docs.yml | 2 +- docs/develop/gettingstarted.rst | 2 +- docs/requirements.txt | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index afc3166f3d..a0105d6ca6 100644 --- 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 index 34ca1c9c63..a17a320671 100644 --- 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 new file mode 100644 index 0000000000..824e9799c7 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx~=7.2.6 +sphinxcontrib.jquery==4.1