OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/scripts/requirements-doc.txt

15 lines
290 B
Plaintext
Raw Normal View History

scripts/requirements: Split & document requirement.txt Split up requirements.txt into several files so that CI tools can utilize/reference the specific requirements-<FOO>.txt they may need while keep things in sync with the development. This is to reduce both time and amount of work CI actions due to python package install. Create the following groupings: 1. BASE - needed to build or create zephyr images 2. BUILD-TEST - need to run compile/build tests 3. DOC - need to build the docs 4. RUN-TEST - need for runtime testing 5. EXTRAS - optional or useful for development/developers workflow Also tried to add a comment about what or why a given package is being pulled in for. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2020-02-08 04:58:00 +08:00
# DOC: used to generate docs
doc: requirements: stick to breathe < 4.33 Looks like the 4.33 release has some more issues, so let's wait until everything gets fixed before allowing future versions. Ref. https://github.com/michaeljones/breathe/issues/805 Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-15 17:39:00 +08:00
breathe>=4.30,<4.33 # 4.33: disabled due to #803 and #805 issues
doc: update requirements breathe: for simplicity, require versions > 4.30 (lower versions have known issues, so do not take risks). Sphinx: start requiring versions >=4.x. Keep with compatible versions, since Sphinx major updrages can easily break extensions, themes, etc. sphinx_rtd_theme: upgrade to >=1.x. Again, keep with compatible versions since we have style customizations that can likely break on major upgrades. pygments: Allow any version >=2.9 (version that introduced DT support). We do not have strong compatibility requirements here. sphinx-notfound-page: Remove any requirements, we do not have strong requirements for this one. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-01-03 17:46:36 +08:00
sphinx~=4.0
sphinx_rtd_theme~=1.0
scripts/requirements: Split & document requirement.txt Split up requirements.txt into several files so that CI tools can utilize/reference the specific requirements-<FOO>.txt they may need while keep things in sync with the development. This is to reduce both time and amount of work CI actions due to python package install. Create the following groupings: 1. BASE - needed to build or create zephyr images 2. BUILD-TEST - need to run compile/build tests 3. DOC - need to build the docs 4. RUN-TEST - need for runtime testing 5. EXTRAS - optional or useful for development/developers workflow Also tried to add a comment about what or why a given package is being pulled in for. Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2020-02-08 04:58:00 +08:00
sphinx-tabs
sphinxcontrib-svg2pdfconverter
doc: update requirements breathe: for simplicity, require versions > 4.30 (lower versions have known issues, so do not take risks). Sphinx: start requiring versions >=4.x. Keep with compatible versions, since Sphinx major updrages can easily break extensions, themes, etc. sphinx_rtd_theme: upgrade to >=1.x. Again, keep with compatible versions since we have style customizations that can likely break on major upgrades. pygments: Allow any version >=2.9 (version that introduced DT support). We do not have strong compatibility requirements here. sphinx-notfound-page: Remove any requirements, we do not have strong requirements for this one. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-01-03 17:46:36 +08:00
pygments>=2.9
sphinx-notfound-page
doc: enable sphinx-copybutton extension The sphinx-copybutton extension adds a button to every code snippet that, when clicked, copies the code to the clipboard. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-25 20:29:37 +08:00
sphinx-copybutton
requirements-doc: add missing pkwalify doc/CMakeLists.txt uses zephyr_module Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-01-09 05:43:25 +08:00
requirements-doc: add PyYAML which removes dependency on -base This means a light requirements-doc.txt is enough for doc writers. See previous discussions in PR #31199 and PR #31239 Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-01-09 05:43:25 +08:00
# YAML validation. Used by zephyr_module.
PyYAML>=5.1
requirements-doc: add missing pkwalify doc/CMakeLists.txt uses zephyr_module Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2021-01-09 05:43:25 +08:00
pykwalify