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

14 lines
242 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: make breathe version specifier more flexible Breathe project has released version 4.29.1, a fix release for the issues found in 4.29.0. Relax version requirements by just skipping the buggy version and staying to compatible releases. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-04-24 23:03:25 +08:00
breathe~=4.23,!=4.29.0
doc: make Sphinx version specifier more flexible Allow all compatible versions starting from 3.3, that is >=3.3.0,<4.0. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-04-24 23:15:55 +08:00
sphinx~=3.3
doc: flexibilize sphinx-rtd-theme allowed versions Allow versions starting from 0.5.2 up to < 1.0, be the next major releases. Major releases tend to include breaking changes, so better restrict such releases until they are manually tested for potential regressions. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-04-08 00:29:50 +08:00
sphinx_rtd_theme>=0.5.2,<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: use pygments devicetree language support Since Pygments 2.7.0 devicetree syntax is supported, so there is no need to use a custom lexer. Version 2.9.0 introduces a fix that is required for some devicetree snippets. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-03-17 18:21:21 +08:00
pygments~=2.9
doc: fix 404 page Sphinx handling of 404 page is not that easy when using theme customizations. Enabled the `sphinx-notfound-page` extension (maintained by readthedocs) to fix its displaying. Also adjusted Zephyr logo (was causing some Sphinx processing errors when trying to scale it). Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2021-05-19 22:04:20 +08:00
sphinx-notfound-page>=0.6
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