doc: touch up manuals, enable fail-on-warning for docs #4416
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
Fix duplicate envvar documentation (envvars can only have one definition in rst), and expand the description. Consistent formatting for envvar documentation. Move the description of the duration string format to the common section, as it's referenced by multiple components (currently control service and router). Fix reference to spao.
We want clean builds without warnings. Enable fail on warning in the readthedocs pipeline and in local builds.
matzf
force-pushed
the
doc-manual-fixes
branch
from
38f9562
to
c3114de
Compare
FR4NK-W
approved these changes
Oct 12, 2023
There was a problem hiding this comment.
Reviewed 7 of 7 files at r1, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @matzf)
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.
remote_interface_idintopology.jsonfor peering links (fix-up for Peering links continued #4390)This change is