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

Update the Python API docs landing page #3437

Closed
emilk opened this issue Sep 25, 2023 · 1 comment · Fixed by #3565
Closed

Update the Python API docs landing page #3437

emilk opened this issue Sep 25, 2023 · 1 comment · Fixed by #3565
Assignees
@jleibs
Labels
📖 documentation Improvements or additions to documentation enhancement New feature or request 🐍 Python API Python logging API
Milestone
0.9 - Codegen, Ty...

Comments

@emilk
Copy link
Member

emilk commented Sep 25, 2023 •
edited
Loading

We need to update rerun_py/docs/gen_common_index.py

Also take a look at rerun_py/docs/gen_package_index.py
@emilk emilk added enhancement New feature or request 🐍 Python API Python logging API 📖 documentation Improvements or additions to documentation labels Sep 25, 2023
@emilk emilk changed the title Clean up the Python API docs Update the Python API landing page Sep 25, 2023
@emilk emilk changed the title Update the Python API landing page Update the Python API docs landing page Sep 25, 2023
@jleibs jleibs self-assigned this Sep 27, 2023
@jleibs
Copy link
Member

jleibs commented Sep 27, 2023

Note: due to the way we do extensions now, we need to enable documentation for inherited_members and verify it does what we expect.

@nikolausWest nikolausWest mentioned this issue Sep 27, 2023
Closed
@jleibs jleibs mentioned this issue Sep 29, 2023
Merged
3 tasks
jleibs added a commit that referenced this issue Oct 2, 2023
@jleibs
Update the python API docs site for the new APIs (#3565)
23dd97b 
### What
 - Builds on top of: #3564
 - Resolves: #3437
 
Replaces the logging functions with the archetypes.
Moves the deprecated function to their own section.

Also fixes the color inversion issue.

### Checklist
* [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)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3565) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3565)
- [Docs
preview](https://rerun.io/preview/85bdc0990d13a21c0cf1c2385e6601af2a9edaf8/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/85bdc0990d13a21c0cf1c2385e6601af2a9edaf8/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jleibs jleibs

Labels
📖 documentation Improvements or additions to documentation enhancement New feature or request 🐍 Python API Python logging API
Projects
None yet
Milestone
0.9 - Codegen, Type Oriented Api
Development

Successfully merging a pull request may close this issue.

Update the python API docs site for the new APIs rerun-io/rerun
2 participants
@emilk @jleibs