From 7f9215da0ead2fa5e6ac0a0e0c063f8b4bc6d6c3 Mon Sep 17 00:00:00 2001 From: Gerard Marull-Paretas Date: Thu, 29 Jun 2023 11:11:34 +0200 Subject: [PATCH] doc: move requirements to doc/ Zephyr scripts do not require documentation dependencies, so let's move them from scripts/ to doc/. Signed-off-by: Gerard Marull-Paretas --- .github/workflows/doc-build.yml | 10 +++++----- doc/contribute/documentation/generation.rst | 2 +- scripts/requirements-doc.txt => doc/requirements.txt | 0 scripts/requirements.txt | 1 - 4 files changed, 6 insertions(+), 7 deletions(-) rename scripts/requirements-doc.txt => doc/requirements.txt (100%) diff --git a/.github/workflows/doc-build.yml b/.github/workflows/doc-build.yml index 6801fc24f8..40e170ddc8 100644 --- a/.github/workflows/doc-build.yml +++ b/.github/workflows/doc-build.yml @@ -22,7 +22,7 @@ on: - 'west.yml' - '.github/workflows/doc-build.yml' - 'scripts/dts/**' - - 'scripts/requirements-doc.txt' + - 'doc/requirements.txt' env: # NOTE: west docstrings will be extracted from the version listed here @@ -57,12 +57,12 @@ jobs: uses: actions/cache@v3 with: path: ~/.cache/pip - key: pip-${{ hashFiles('scripts/requirements-doc.txt') }} + key: pip-${{ hashFiles('doc/requirements.txt') }} - name: install-pip run: | sudo pip3 install -U setuptools wheel pip - pip3 install -r scripts/requirements-doc.txt + pip3 install -r doc/requirements.txt pip3 install west==${WEST_VERSION} pip3 install cmake==${CMAKE_VERSION} @@ -137,7 +137,7 @@ jobs: uses: actions/cache@v3 with: path: ~/.cache/pip - key: pip-${{ hashFiles('scripts/requirements-doc.txt') }} + key: pip-${{ hashFiles('doc/requirements.txt') }} - name: setup-venv run: | @@ -148,7 +148,7 @@ jobs: - name: install-pip run: | pip3 install -U setuptools wheel pip - pip3 install -r scripts/requirements-doc.txt + pip3 install -r doc/requirements.txt pip3 install west==${WEST_VERSION} pip3 install cmake==${CMAKE_VERSION} diff --git a/doc/contribute/documentation/generation.rst b/doc/contribute/documentation/generation.rst index 7f2b6ef2d0..756c1c2a70 100644 --- a/doc/contribute/documentation/generation.rst +++ b/doc/contribute/documentation/generation.rst @@ -80,7 +80,7 @@ Our documentation processing has been tested to run with: * Graphviz 2.43 * Latexmk version 4.56 * All Python dependencies listed in the repository file - ``scripts/requirements-doc.txt`` + ``doc/requirements.txt`` In order to install the documentation tools, first install Zephyr as described in :ref:`getting_started`. Then install additional tools diff --git a/scripts/requirements-doc.txt b/doc/requirements.txt similarity index 100% rename from scripts/requirements-doc.txt rename to doc/requirements.txt diff --git a/scripts/requirements.txt b/scripts/requirements.txt index 7bb405afaa..e10831d8d6 100644 --- a/scripts/requirements.txt +++ b/scripts/requirements.txt @@ -1,6 +1,5 @@ -r requirements-base.txt -r requirements-build-test.txt --r requirements-doc.txt -r requirements-run-test.txt -r requirements-extras.txt -r requirements-compliance.txt