[BUG] Can't build the documentation sets for Bridle and Zephyr anymore #270
Comments
rexut
added a commit
that referenced
this issue
Nov 10, 2024
Add statement about the copy-and-onw of Sphinx extension warnings_filter. Add GitHub issues #270, #271 and #272. Signed-off-by: Stephan Linz <[email protected]>
rexut
added a commit
that referenced
this issue
Nov 10, 2024
Add statement about the copy-and-onw of Sphinx extension warnings_filter. Add GitHub issues #270, #271 and #272. Signed-off-by: Stephan Linz <[email protected]>
rexut
added a commit
that referenced
this issue
Nov 14, 2024
Add statement about the copy-and-onw of Sphinx extension warnings_filter. Add GitHub issues #270, #271 and #272. Signed-off-by: Stephan Linz <[email protected]>
rexut
added a commit
that referenced
this issue
Nov 14, 2024
Add statement about the copy-and-own of Sphinx extension warnings_filter. Add GitHub issues #270, #271 and #272. Signed-off-by: Stephan Linz <[email protected]>
rexut
added a commit
that referenced
this issue
Nov 15, 2024
Add statement about:
* the CI workflow changes
* the standalone 'stm32f777xx' SoC support by Bridle
* the DTS binding and Kconfig changes for the two I2C-based
GPIO expander 'PCA9554' and 'PCA9555'
* the copy-and-own of Sphinx extension 'warnings_filter'
* the changes on documentation level: Sphinx v8.1, Sphinx
copy button, inter-Sphinx links with valid official syntax
and update output messages
Add GitHub issues #270, #271 and #272.
Signed-off-by: Stephan Linz <[email protected]>
rexut
added a commit
that referenced
this issue
Nov 15, 2024
Add statement about:
* the CI workflow changes
* the standalone 'stm32f777xx' SoC support by Bridle
* the DTS binding and Kconfig changes for the two I2C-based
GPIO expander 'PCA9554' and 'PCA9555'
* the copy-and-own of Sphinx extension 'warnings_filter'
* the changes on documentation level: Sphinx v8.1, Sphinx
copy button, inter-Sphinx links with valid official syntax
and update output messages
Add GitHub issues #270, #271 and #272.
Signed-off-by: Stephan Linz <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the bug
Since Zephyr upstream goes on to v4.0 and thus removes some major functional features for processing all the spreaded RST documentation in code we are no longer able to rebuild our own downstream documentation sets for Bridle. The following functions have been removed without replacement:
breathedeactivated: Zephyr no longer render Doxygen content inside of Sphinx. See:zephyr.warnings_filterdeactivated: This is no longer needed as Zephyr link directly to Doxygen pages sincebreathewas removed. See:doc/known-warnings.txt)Additional changes inside the Zephyr upstream documentation build process that Bridle now have to or should respect:
zephyr.link-roles. See:ZEPHYR_BASE_DIR. See:DOCS_HTML_DIRtoOUTPUT_DIR. See:make html-liveandhtml-live-fastzephyrproject-rtos/zephyr#72607 – Control Sphinx output folder from CMake with environment variableDOCS_HTML_DIR. See:To Reproduce
Steps to reproduce the behavior:
mainbranchcmake -Bbuild/bridle-doc -GNinja bridle/docninja -Cbuild/bridle-doc zephyr-doxygenninja -Cbuild/bridle-doc bridle-doxygenninja -Cbuild/bridle-doc build-allExpected behavior
Rebuild all documentation sats as before.
Impact
Showstopper: can't release next Bridle version.
Logs and console output
See above.
Screenshots
None.
Development Environment (please complete the following information):
main, Zephyr v4.0.0-rc1 (upstreammain)Additional context
None.
Procedure
Error correction is increasingly proving to be a more complex challenge than initially expected. We will therefore proceed via several pull requests in the following individual steps.
zephyr.warnings_filterSphinx extension asbridle.warnings_filter– as long as Bridle have to rebuild different documentation sets by a splitted strategy (apartly the document inventory first and then the other documents at all that dependent to other inventories), Bridle have to expect and tolerate warnings of unknown or invalid references to "other" inter-Sphinx documents. In the past it was a good practice to filter out such expected warnings explicitly by thewarnings_filter.breathe(andinterbreathe) also for the Bridle documentation set in the same manner as Zephyr already done. The Bridle documentation will swap to the new functionality by the Zephyr provided Sphinx extensionszephyr.doxybridgeand maybezephyr.doxytooltipThe text was updated successfully, but these errors were encountered: