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

27 lines
448 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: Relax Sphinx pip dependency As Zephyr now supports Python 3.10 and onwards, we can use more recent versions of Sphinx, i.e 7.3.x at the time of this commit. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-04-30 18:13:25 +08:00
sphinx
doc: requirements: Update to Sphinx RTD Theme 3.0 Update to latest Sphinx RTD Theme version. Main benefit will be to be able to leverage Sphinx 8.0 since previous version of the theme was depending on 'sphinx < 8.0'. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-08-20 23:11:32 +08:00
sphinx_rtd_theme~=3.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
doc: Make code-samples admonition collapsible Use sphinx-toggle to make "Related code samples" collapsible. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-30 15:26:48 +08:00
sphinx-togglebutton
doc: generate sitemap.xml Generate a sitemap.xml for the documentation. This aims at helping search engines react faster to the addition/removal of new pages. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-02-26 18:59:57 +08:00
sphinx-sitemap
doc: add `make html-live` and `html-live-fast` Add two new commands that automatically locally host the generated documentation upon completion and rebuild/rehost when the input files change without any user interaction. For more info see: https://pypi.org/project/sphinx-autobuild/ Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-05-11 10:07:11 +08:00
sphinx-autobuild
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.
scripts: dts: update pyyaml version The currently used PyYaml version has some vulnerabilies as described on the pull request description. It updates to version 6.0, removing these supply chain vulnerabily. The OSSF Scorecard was the tool used for discovering these vulnerabilties. Signed-off-by: Javan lacerda <javanlacerda@google.com>
2024-03-27 22:01:44 +08:00
PyYAML>=6.0
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
doc: test: improve pytest documentation Improve documentation about pytest integration with Twister. Add examples of usage, improve description of available options and introduce automatic doc generation of two plugin classes (DeviceAdapter and Shell) basing on their docstrings from source code. Signed-off-by: Piotr Golyzniak <piotr.golyzniak@nordicsemi.no>
2023-11-23 02:57:10 +08:00
doc: requirements: Add pyserial Since 7eaca455faf6ff8d9a92c4392da281dab08d0c2b, pyserial is required for building docs because `DeviceAdapter` from the `pytest-twister-harness` plugin, which is imported by autodoc, now depends on it. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2024-05-23 21:08:03 +08:00
# Used by pytest-twister-harness plugin (imported by autodoc)
doc: test: improve pytest documentation Improve documentation about pytest integration with Twister. Add examples of usage, improve description of available options and introduce automatic doc generation of two plugin classes (DeviceAdapter and Shell) basing on their docstrings from source code. Signed-off-by: Piotr Golyzniak <piotr.golyzniak@nordicsemi.no>
2023-11-23 02:57:10 +08:00
pytest
doc: requirements: Add pyserial Since 7eaca455faf6ff8d9a92c4392da281dab08d0c2b, pyserial is required for building docs because `DeviceAdapter` from the `pytest-twister-harness` plugin, which is imported by autodoc, now depends on it. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2024-05-23 21:08:03 +08:00
pyserial
doc: Include doxmlparser on requirements.txt It will be necessary to parse the doxygen XML files to extract `since` and `version` from them. Signed-off-by: Ederson de Souza <ederson.desouza@intel.com>
2023-11-01 07:25:14 +08:00
# Doxygen doxmlparser
doxmlparser
doc: extensions: samples: Introduce code sample categories This commit adds support for categorizing code samples in the documentation. It introduces two new directives: - `zephyr:code-sample-category::` to create a category and associated brief description, that implicitly acts as a toctree too. - `zephyr:code-sample-listing::` to allow dumping a list of samples corresponding to a category anywhere in the documentation. Fixes #62453. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-16 16:53:07 +08:00
# Used by the Zephyr domain to organize code samples
anytree