Sphinx warnings and errors fix #5815
Merged
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
|
Dear contributor,
As for the Avocado utility modules (“avocado.utils”) it is OK to introduce new functionality, |
richtja
force-pushed
the
sphinx_fix
branch
13 times, most recently
from
5a08f3c
to
06be3ae
Compare
Reference: avocado-framework#5757 Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
The sphinx-apidoc command didn't respect the namespaces of optional plugins, because of that the generated documentation didn't point to right modules. Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
varianter plugins doc has been moved to its own subsection therefore we need to remove them from toctree. Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
Signed-off-by: Jan Richter <[email protected]>
This commit introduces the static checks for avocado documentation. This change will help us avoid documentation issues in the future. It makes the readthedocs build more strict, which make it fail on any warning. Reference: avocado-framework#5757 Signed-off-by: Jan Richter <[email protected]>
clebergnu
approved these changes
Dec 7, 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.
This PR fixes Sphinx warnings and errors in our documentation and adds static tests to avoid those problems in the future.
Reference: #5757
Signed-off-by: Jan Richter [email protected]