Automatically generate the bootstrap config documentation #711
+669
−512
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
|
The doc automation is ready, I need to add the missing docstrings to |
The bootstrap config documentation may get out of sync as a result of apiv1.BootstrapConfig changes. To avoid this, we're going to automatically generate the documentation based on the apiv1.BootstrapConfig structure definition and docstrings. This change adds the necessary tooling as part of the ``docgen`` package, which may be reused for other structures or projects.
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.
The bootstrap config documentation may get out of sync as a result of apiv1.BootstrapConfig changes.
To avoid this, we're going to automatically generate the documentation based on the apiv1.BootstrapConfig structure definition and docstrings.
This change adds the necessary tooling as part of the
docgenpackage, which may be reused for other structures or projects.