doc: Generate config value reference #1052
Open
+448
−26
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
LecrisUT
force-pushed
the
doc/config-ref
branch
from
8e41cf9 to
bfeb494
Compare
- Moved default text handling to a separate function - Prepare to read metadata fields from dataclasses.Field.metadata - Added a dataclass holder for the dataclass field metadata for documentation Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
Signed-off-by: Cristian Le <[email protected]>
LecrisUT
force-pushed
the
doc/config-ref
branch
from
bfeb494 to
b07e098
Compare
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 would make it easier to cross-reference. I was debating going for an auto-generated one and integrating with sphinx directly or going with the
nox -t genfiles, and I think I prefer the latter because it makes it more obvious to review the generated text in all the places, wdyt?I also want to unlock usage of sphinx roles in it, but the readme generation gets in the way. My opinion is that if we have this, we could either move the readme part to the generated page, or truncate it to only display the first summary sentence similar to how
clickdoes it.Depends-on: #1051
Closes #999