Skip to content

Commit

Permalink
Tweak the Python API docs to look nicer (rerun-io#3622)
Browse files Browse the repository at this point in the history
### What
* Closes rerun-io#3621

Tweaks the Python API docs to look nicer.

Smaller example images (and fewer examples) reduces the amount of
scrolling required to see the `init` method:


![image](https://github.com/rerun-io/rerun/assets/1148717/9ceff6a4-126e-4b80-b0ef-3c404110830c)

### 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/3622) (if
applicable)

- [PR Build Summary](https://build.rerun.io/pr/3622)
- [Docs
preview](https://rerun.io/preview/99746c8cb755e17638b60dff3e9303ef0301b4db/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/99746c8cb755e17638b60dff3e9303ef0301b4db/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
  • Loading branch information
emilk authored Oct 3, 2023
1 parent e5b2af7 commit 4ff8bf8
Show file tree
Hide file tree
Showing 134 changed files with 600 additions and 558 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/contrib_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ jobs:
- name: Build via mkdocs
run: |
mkdocs build -f rerun_py/mkdocs.yml
mkdocs build --strict -f rerun_py/mkdocs.yml
no-codegen-changes:
name: Check if running codegen would produce any changes
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/reusable_checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ jobs:
- name: Build via mkdocs
run: |
mkdocs build -f rerun_py/mkdocs.yml
mkdocs build --strict -f rerun_py/mkdocs.yml
# ---------------------------------------------------------------------------

Expand Down
3 changes: 3 additions & 0 deletions crates/re_types/definitions/rerun/archetypes/asset3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace rerun.archetypes;

/// A prepacked 3D asset (`.gltf`, `.glb`, `.obj`, etc.).
///
/// \py See also [`Mesh3D`][rerun.archetypes.Mesh3D].
/// \rs See also [`Mesh3D`][crate::archetypes::Mesh3D].
///
/// \example asset3d_simple "Simple 3D asset"
/// \example asset3d_out_of_tree "3D asset with out-of-tree transform"
table Asset3D (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ namespace rerun.archetypes;

/// A batch of line strips with positions and optional colors, radii, labels, etc.
///
/// \example line_strip2d_simple image="https://static.rerun.io/line_strip2d_simple/c4e6ce937544e66b497450fd64ac3ac2f244f0e1/1200w.png"
/// \example line_segments2d_simple image="https://static.rerun.io/line_segment2d_simple/53df596662dd9ffaaea5d09d091ef95220346c83/1200w.png"
/// \example line_strip2d_batch image="https://static.rerun.io/line_strip2d_batch/d8aae7ca3d6c3b0e3b636de60b8067fa2f0b6db9/1200w.png"
table LineStrips2D (
"attr.rust.derive": "PartialEq"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ namespace rerun.archetypes;

/// A batch of line strips with positions and optional colors, radii, labels, etc.
///
/// \example line_strip3d_simple title="Simple example" image="https://static.rerun.io/line_strip3d_simple/13036c0e71f78d3cec37d5724f97b47c4cf3c429/1200w.png"
/// \example line_segments3d_simple title="Many individual segments" image="https://static.rerun.io/line_segment3d_simple/aa800b2a6e6a7b8e32e762b42861bae36f5014bb/1200w.png"
/// \example line_strip3d_batch title="Many strips" image="https://static.rerun.io/line_strip3d_batch/102e5ec5271475657fbc76b469267e4ec8e84337/1200w.png"
table LineStrips3D (
"attr.rust.derive": "PartialEq"
Expand Down
3 changes: 3 additions & 0 deletions crates/re_types/definitions/rerun/archetypes/mesh3d.fbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ namespace rerun.archetypes;

/// A 3D triangle mesh as specified by its per-mesh and per-vertex properties.
///
/// \py See also [`Asset3D`][rerun.archetypes.Asset3D].
/// \rs See also [`Asset3D`][crate::archetypes::Asset3D].
///
/// \example mesh3d_indexed "Simple indexed 3D mesh"
/// \example mesh3d_partial_updates "3D mesh with partial updates"
table Mesh3D (
Expand Down
12 changes: 9 additions & 3 deletions crates/re_types/src/archetypes/annotation_context.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion crates/re_types/src/archetypes/arrows3d.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions crates/re_types/src/archetypes/asset3d.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/re_types/src/archetypes/bar_chart.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions crates/re_types/src/archetypes/boxes3d.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions crates/re_types/src/archetypes/depth_image.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions crates/re_types/src/archetypes/disconnected_space.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion crates/re_types/src/archetypes/image.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

63 changes: 5 additions & 58 deletions crates/re_types/src/archetypes/line_strips2d.rs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 4ff8bf8

Please sign in to comment.