Add support for classes to generated python common API index #2401
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
emilk
approved these changes
Jun 13, 2023
| @@ -75,7 +75,9 @@ | |||
| {% set heading_level = heading_level - 1 %} | |||
| {% endif %} | |||
|
|
|||
| <div class="doc doc-contents {% if root %}first{% endif %}"> | |||
| {# CHANGE: disable gating of first for root docstring #} | |||
There was a problem hiding this comment.
I have trouble parsing this sentence
jleibs
added a commit
that referenced
this pull request
Jun 13, 2023
Classes such as `ClassDescription` and `AnnotationInfo` make up an import part of the API surface for many rerun APIs. Add support for the classes to `gen_common_index.py`. TODO: - [ ] After landing, cherry-pick into release-0.6 Additional: - set the heading_level for these generated components to 4, which matches the styling from the full package index and results in better TOC representation. - Add the same template modification that we use from functions to disable `first` so we get a continuity bar for the class rendering like we do for functions. - Modify the CSS so that links are visible. Previews:   Related to: #2385 Closes: #2393 * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [ ] I've included a screenshot or gif (if applicable) <!-- This line will get updated when the PR build summary job finishes. --> PR Build Summary: https://build.rerun.io/pr/2401 <!-- pr-link-docs:start --> Docs preview: https://rerun.io/preview/b58a10c/docs Examples preview: https://rerun.io/preview/b58a10c/examples <!-- pr-link-docs:end -->
emilk
pushed a commit
that referenced
this pull request
Jun 15, 2023
Classes such as `ClassDescription` and `AnnotationInfo` make up an import part of the API surface for many rerun APIs. Add support for the classes to `gen_common_index.py`. TODO: - [ ] After landing, cherry-pick into release-0.6 Additional: - set the heading_level for these generated components to 4, which matches the styling from the full package index and results in better TOC representation. - Add the same template modification that we use from functions to disable `first` so we get a continuity bar for the class rendering like we do for functions. - Modify the CSS so that links are visible. Previews:   Related to: #2385 Closes: #2393 * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [ ] I've included a screenshot or gif (if applicable) <!-- This line will get updated when the PR build summary job finishes. --> PR Build Summary: https://build.rerun.io/pr/2401 <!-- pr-link-docs:start --> Docs preview: https://rerun.io/preview/b58a10c/docs Examples preview: https://rerun.io/preview/b58a10c/examples <!-- pr-link-docs:end -->
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.
What
Classes such as
ClassDescriptionandAnnotationInfomake up an import part of the API surface for many rerun APIs. Add support for the classes togen_common_index.py.TODO:
Additional:
firstso we get a continuity bar for the class rendering like we do for functions.Previews:
Related to: #2385
Closes: #2393
Checklist
PR Build Summary: https://build.rerun.io/pr/2401
Docs preview: https://rerun.io/preview/b58a10c/docs
Examples preview: https://rerun.io/preview/b58a10c/examples