Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add support for classes in Python doc pages #1251

Closed
Wumpf opened this issue Feb 13, 2023 · 3 comments
Closed

Add support for classes in Python doc pages #1251

Wumpf opened this issue Feb 13, 2023 · 3 comments
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation

Comments

@Wumpf
Copy link
Member

Wumpf commented Feb 13, 2023

e.g. LogHandler and LogLevel aren't in the generated documentation page yet because of this
@Wumpf Wumpf added the 📖 documentation Improvements or additions to documentation label Feb 13, 2023
@jleibs
Copy link
Member

jleibs commented Feb 14, 2023 •
edited
Loading

The doc pages should support classes already. You should be able to add "log.text.LoggingHandler" to the generator.

The class annotations seem to be working in the package manifest:
https://rerun-io.github.io/rerun/docs/python/latest/package/rerun/log/text/#rerun.log.text.LogLevel

@emilk emilk added the 🪳 bug Something isn't working label Jun 12, 2023
@emilk
Copy link
Member

emilk commented Jun 12, 2023

For instance: We don't have a link to AnnotationContext from https://ref.rerun.io/docs/python/v0.6.0/common/

@nikolausWest
Copy link
Member

Done in #2401

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🪳 bug Something isn't working 📖 documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@emilk @Wumpf @nikolausWest @jleibs