fix: eliminate misc sphinx warnings... #6929
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
...and miscellaneous doc fixes/oversights from past updates. - Sphinx issues warnings/errors when section heading underlines are not long enough or uses a character that does not fit the document structure already established. - The .. code-block:: <lang> updates are for correct syntax coloring. Just plain .. code:: sometimes does not do syntax coloring correctly. - Also fixed are a few urecognized interpreted-text prefixes, e.g. :refr: is misspelled and must be :ref: or sphinx doesn't know what to do with it.
kisvegabor
approved these changes
Sep 25, 2024
liamHowatt
approved these changes
Sep 26, 2024
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.
...and miscellaneous doc fixes/oversights from past updates.
Notes
lv_conf_template.hrun lv_conf_internal_gen.py and update Kconfig.scripts/code-format.py(astyle v3.4.12needs to installed by runningcd scripts; ./install_astyle.sh) and follow the Code Conventions.