zephyr/scripts/requirements-doc.txt

# DOC: used to generate docs

breathe>=4.23.0,<4.29.0
sphinx>=3.3.0,<3.4.0
sphinx_rtd_theme>=0.5.2,<1.0
sphinx-tabs
sphinxcontrib-svg2pdfconverter

# Used by zephyr_module
pykwalify
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: allow up to breathe 4.28.x It looks like latest release (4.29.0) breaks docs build. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> 2021-04-10 05:57:36 +08:00			`breathe>=4.23.0,<4.29.0`
doc: fix broken text search Require Sphinx<3.4.0 to avoid the issue described in: https://github.com/sphinx-doc/sphinx/issues/8603 This requirement can be relaxed once a new sphinx-rtd-theme is released. Signed-off-by: Fabio Utzig <fabio.utzig@nordicsemi.no> 2020-12-28 20:15:48 +08:00			`sphinx>=3.3.0,<3.4.0`
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`
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
			`# Used by zephyr_module`
			`pykwalify`