You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
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.
The text was updated successfully, but these errors were encountered:
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.
iframe
: it is not possible to link to existing anchors in the iframe (iframe allows the use of the javascript for browsing)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:
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.The text was updated successfully, but these errors were encountered: