Update the python API docs site for the new APIs #3565
Merged
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
jleibs
changed the title
Wumpf
approved these changes
Oct 2, 2023
rerun_py/docs/gen_common_index.py
Outdated
| ], | ||
| class_list=[], | ||
| func_list=[], | ||
| class_list=["Points2D", "Points3D", "Boxes2D", "Boxes3D", "LineStrips2D", "LineStrips3D", "Mesh3D", "Asset3D"], |
There was a problem hiding this comment.
Ordered by increasing complexity of object. Same as how the functions were ordered.
rerun_py/docs/package/index.md
Outdated
| - [rerun.log][]: APIs for logging data | ||
| - [rerun.color_conversion][]: Conversion utilities related to colors | ||
| - [rerun.components][]: Helpers for constructing arrow components | ||
| - [rerun.archetypes][]: Common objects for logging primitives understood by the viewer, e.g. Points and Lines. |
There was a problem hiding this comment.
Suggested change
| - [rerun.archetypes][]: Common objects for logging primitives understood by the viewer, e.g. Points and Lines. | |
| - [rerun.archetypes][]: Common objects for logging tagged data understood by the viewer, e.g. Points and Lines. |
maybe better? I'm getting more and more uneasy around "primitives". Putting tagged here might be too much though (also we never call the indicators 'tagged'), but maybe something like this
|
The generated documentation structure is pretty badly broken for me. This is clicking Point2d from the "landing page": 
Notice no title or anything for the class. Also note TOC on the right hand side. On Safari, this is aggravated by layout issues: 
|
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
log_prefixed APIs. #3564Replaces the logging functions with the archetypes.
Moves the deprecated function to their own section.
Also fixes the color inversion issue.
Checklist