Skip to content

Auto-generated links to reference in docs #4048

@abey79

Description

@abey79

In our docs, when we mention some APIs from our SDK, it would be nice that links to related reference would be auto-generated on our landing page.

Example use-cases

  • The Events and Timelines provide a snippet in all 3 supported languages (since Update the "Events and Timelines" docs page #4039), but when referencing specific APIs in the text, we must chose a language and hard code links to the reference documentation. In such case, the link should somehow dispatch to any of the supported languages.
  • In .fbs files, it would be nice to have links when referring to other objects, which happens often. In this case, the links should use the same language as the originating page.

Python implementation details

In general, it is kind of tricky to derive a link from an API element. Luckily, our documentation already generates an objects.inv machine-readable index, e.g. https://ref.rerun.io/docs/python/0.9.1/objects.inv.

Metadata

Metadata

Assignees

No one assigned

    Labels

    📖 documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions