patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity

doc: move requirements to doc/

Browse source 
Zephyr scripts do not require documentation dependencies, so let's
move them from scripts/ to doc/.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2023-06-29 11:11:34 +02:00 committed by Anas Nashif
parent b990a5fdb6
commit 7f9215da0e
4 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
.github/workflows/doc-build.yml vendored
View file

@ -22,7 +22,7 @@ on:
- 'west.yml' - 'west.yml'
- '.github/workflows/doc-build.yml' - '.github/workflows/doc-build.yml'
- 'scripts/dts/**' - 'scripts/dts/**'
- 'scripts/requirements-doc.txt' - 'doc/requirements.txt'
env: env:
# NOTE: west docstrings will be extracted from the version listed here # NOTE: west docstrings will be extracted from the version listed here
@ -57,12 +57,12 @@ jobs:
uses: actions/cache@v3 uses: actions/cache@v3
with: with:
path: ~/.cache/pip path: ~/.cache/pip
key: pip-${{ hashFiles('scripts/requirements-doc.txt') }} key: pip-${{ hashFiles('doc/requirements.txt') }}
- name: install-pip - name: install-pip
run: | run: |
sudo pip3 install -U setuptools wheel pip 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 west==${WEST_VERSION}
pip3 install cmake==${CMAKE_VERSION} pip3 install cmake==${CMAKE_VERSION}
@ -137,7 +137,7 @@ jobs:
uses: actions/cache@v3 uses: actions/cache@v3
with: with:
path: ~/.cache/pip path: ~/.cache/pip
key: pip-${{ hashFiles('scripts/requirements-doc.txt') }} key: pip-${{ hashFiles('doc/requirements.txt') }}
- name: setup-venv - name: setup-venv
run: | run: |
@ -148,7 +148,7 @@ jobs:
- name: install-pip - name: install-pip
run: | run: |
pip3 install -U setuptools wheel pip 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 west==${WEST_VERSION}
pip3 install cmake==${CMAKE_VERSION} pip3 install cmake==${CMAKE_VERSION}

2
doc/contribute/documentation/generation.rst
View file

@ -80,7 +80,7 @@ Our documentation processing has been tested to run with:
* Graphviz 2.43 * Graphviz 2.43
* Latexmk version 4.56 * Latexmk version 4.56
* All Python dependencies listed in the repository file * 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 In order to install the documentation tools, first install Zephyr as
described in :ref:`getting_started`. Then install additional tools described in :ref:`getting_started`. Then install additional tools

0
scripts/requirements-doc.txt → doc/requirements.txt
View file

1
scripts/requirements.txt
View file

@ -1,6 +1,5 @@
-r requirements-base.txt -r requirements-base.txt
-r requirements-build-test.txt -r requirements-build-test.txt
-r requirements-doc.txt
-r requirements-run-test.txt -r requirements-run-test.txt
-r requirements-extras.txt -r requirements-extras.txt
-r requirements-compliance.txt -r requirements-compliance.txt