Import some documentation infrastructure changes from upstream #1266
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NordicBuilder
requested review from
asbjornsabo,
hermabe,
stephanosio and
Thalley
gmarull
force-pushed
the
import-doc-changes
branch
from
fec89dc
to
0d54113
Compare
nordicjm
requested changes
Aug 8, 2023
There are times when the log message is an exception object and that causes the regex to fail with a TypeError. Here we work around that by converting the input to a string. Signed-off-by: Michael Jones <m.pricejones@gmail.com> (cherry picked from commit 56d7afe)
So that we see all the potential errors in CI and not just the first and can assess how much work there is to do. This was introduced for debuggin but gmarull has suggested keeping it in. Signed-off-by: Michael Jones <m.pricejones@gmail.com> (cherry picked from commit 343f60c)
This allows us to identify any patterns that we can remove or that we didn't realise are no longer in use. This might happen if issues within doxygen or docleaf are resolved. This allows us to remove the pattern: .*Duplicate C declaration.*\n.*'\.\. c:.*:: uint16_t id'.* which does not match anything in the current set up. We also split the filter patterns in known-warnings out into different sections depending on their cause. Also extend the pattern parser to ignore empty lines so that we can have some formatting in the known-warnings file. fromtree notes: slightly adjusted, docleaf changes not imported Signed-off-by: Michael Jones <m.pricejones@gmail.com> Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> (cherry picked from commit 34e5003)
This should allow us to observe faster build times when using parallelization. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> (cherry picked from commit a211469)
We can't use Zephyr custom runners downstream. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Run Sphinx in warnings as error mode, but keep going so that all issues are reported to the user. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> (cherry picked from commit 85ec853)
Add a new CMake option to append options to SPHINXOPTS. This allows us to easily extend default SPHINXOPTS. This patch also restores the "-j auto" option in CI (now that we use a custom runner). Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> (cherry picked from commit 2c89bf5)
When something goes wrong in Sphinx or extensions, we'll get a detailed traceback, so we can easily debug issues in CI. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> (cherry picked from commit d3d93d4)
Zephyr scripts do not require documentation dependencies, so let's move them from scripts/ to doc/. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> (cherry picked from commit 7f9215d)
rtd_theme 1.2.x is required when using Sphinx >= 6.0, otherwise certain features like search are broken. Note that jQuery support needs to be enabled manually now using `sphinxcontrib.jquery` extension. Also update Sphinx to latest 6.x release, 6.2 as it contains some fixes. fromtree notes: slightly adjusted, docleaf not imported. Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com> (cherry picked from commit 7c418a0)
The SPHINXOPTS option was not aligned with latest changes in CMake, and SPHINXOPTS_EXTRA was not present. Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com> (cherry picked from commit 77aafa5)
gmarull
force-pushed
the
import-doc-changes
branch
from
0d54113
to
7314532
Compare
|
@nordicjm docleaf stuff dropped |
nordicjm
approved these changes
Aug 11, 2023
gautesl
approved these changes
Aug 11, 2023
umapraseeda
approved these changes
Aug 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
So we are prepared for the next upmerge, and, improve user experience