Switch to a generator for our common-API registry as well. #1035
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
jondo2010
approved these changes
Feb 1, 2023
| @@ -35,6 +35,7 @@ plugins: | |||
| merge_init_into_class: true | |||
| - gen-files: # https://oprypin.github.io/mkdocs-gen-files | |||
| scripts: | |||
| - docs/gen_common_index.py | |||
There was a problem hiding this comment.
The scripts will run in order -- they don't have any cross-dependencies though.
jleibs
force-pushed
the
jleibs/gen_common_index
branch
from
1b99385
to
3e316df
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.
I started hand-crafting this table and realized I'd rather let python to it. Now the whole "common" APIs section is generated dynamically from a single data-structure.
The top-level entry point is now a nicely generated table with just the first-line docstring summaries:
Checklist
CHANGELOG.md(if this is a big enough change to warrant it)