Fix all Sphinx doc generation warnings #11419
Merged
Conversation
This file contains hidden or 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
This fixes all docs Sphinx warnings and turns on the `-W` flag to sphinx so that the build will fail if any warnings get introduced in the future. Many of these changes involve transitioning many of the domains from :c: to :cpp:. Note there are still uses for the :c: domain since some directives we use are only supported there, such as our macros. But many functions and enumerations that used to be c are now cpp.
cmcfarlen
approved these changes
Jun 5, 2024
bneradt
added a commit
to bneradt/trafficserver
that referenced
this pull request
Jun 6, 2024
This fixes all docs Sphinx warnings and turns on the `-W` flag to sphinx so that the build will fail if any warnings get introduced in the future. Many of these changes involve transitioning many of the domains from :c: to :cpp:. Note there are still uses for the :c: domain since some directives we use are only supported there, such as our macros. But many functions and enumerations that used to be c are now cpp. (cherry picked from commit 188a128) Conflicts: doc/developer-guide/api/functions/TSContScheduleEveryOnThread.en.rst
bneradt
added a commit
that referenced
this pull request
Jun 6, 2024
This fixes all docs Sphinx warnings and turns on the `-W` flag to sphinx so that the build will fail if any warnings get introduced in the future. Many of these changes involve transitioning many of the domains from :c: to :cpp:. Note there are still uses for the :c: domain since some directives we use are only supported there, such as our macros. But many functions and enumerations that used to be c are now cpp. (cherry picked from commit 188a128) Conflicts: doc/developer-guide/api/functions/TSContScheduleEveryOnThread.en.rst
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 fixes all docs Sphinx warnings and turns on the
-Wflag to sphinx so that the build will fail if any warnings get introduced in the future.Many of these changes involve transitioning many of the domains from :c: to :cpp:. Note there are still uses for the :c: domain since some directives we use are only supported there, such as our macros. But many functions and enumerations that used to be c are now cpp.