michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Update requirements-doc.txt to use docleaf

Browse source 
Instead of breathe.

I'm not sure of the best version comparison to use. There is no
intention to break the API for docleaf but it is also still young
in some ways and there might be adjustments to the configuration values
that would need to be reflected in the version number as it is still
pre-1.0 that would only be a minor version change.

Signed-off-by: Michael Jones <m.pricejones@gmail.com>
This commit is contained in:
Michael Jones 2023-06-21 20:49:08 +01:00 • committed by Fabio Baltieri
commit 30c3ce4a92
3 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/_extensions/zephyr/doxyrunner.py
View file

@ -9,7 +9,7 @@ Introduction
============ ============
This Sphinx plugin can be used to run Doxygen build as part of the Sphinx build This Sphinx plugin can be used to run Doxygen build as part of the Sphinx build
process. It is meant to be used with other plugins such as ``breathe`` in order process. It is meant to be used with other plugins such as ``docleaf`` in order
to improve the user experience. The principal features offered by this plugin to improve the user experience. The principal features offered by this plugin
are: are:

4
doc/_static/css/custom.css vendored
View file

@ -843,13 +843,13 @@ kbd, .kbd,
background-color: var(--navbar-scrollbar-active-color); background-color: var(--navbar-scrollbar-active-color);
} }
/* Breathe tweaks */ /* Docleaf tweaks */
.rst-content .section > dl > dd { .rst-content .section > dl > dd {
margin-left: 0; margin-left: 0;
} }
.rst-content p.breathe-sectiondef-title { .rst-content p.docleaf-sectiondef-title {
font-size: 115%; font-size: 115%;
color: var(--link-color); color: var(--link-color);
} }

2
scripts/requirements-doc.txt
View file

@ -1,6 +1,6 @@
# DOC: used to generate docs # DOC: used to generate docs
breathe>=4.34 docleaf==0.8.0
sphinx~=5.0,!=5.2.0.post0 sphinx~=5.0,!=5.2.0.post0
sphinx_rtd_theme~=1.0 sphinx_rtd_theme~=1.0
sphinx-tabs sphinx-tabs