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.

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

Sphinx integration support for cross-referencing #247

Open
Hyrae opened this issue Jun 18, 2024 · 0 comments
Open

Sphinx integration support for cross-referencing #247

Hyrae opened this issue Jun 18, 2024 · 0 comments

Comments

@Hyrae
Copy link

Hyrae commented Jun 18, 2024

As mentioned in #14, integrating the output in a Sphinx documentation can be done (see below solutions) but the result is not as good as it could be. The main missing feature is being able to cross-reference objects definition with links within the Sphinx documentation while keeping manual browsing the json-schema objects possible.

  • with an iframe: it is not possible to link to existing anchors in the iframe (iframe allows the use of the javascript for browsing)
  • with the flat template: Anchor links are working, but the sections are not collapsible, making it very tedious to browse the json-schema objects when the json-schema is long.

Possible solutions:

  • Bootstrap collapsible card (https://disjfa.github.io/bootstrap-tricks/card-collapse-tricks/): not sure this works if a there a link to an anchor nested in cards
  • Adding a table of content tree, summarizing the structure of the json-schema at the top, linking to details below
  • Using the Sphinx directive toctree and generate sub-pages for each element, with links to sub-pages when referencing other elements. Each "object" would be listed in the sphinx sidebar.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant