Skip to content

[directive] Collections #40

@gastmaier

Description

@gastmaier

As demonstrated in branch mock (pseudo-code)
Collections are a documentation repo exclusive (probably) directive to aggregate pages across repos, in the same principle as custom doc yaml files, but simpler and stored into a json dict to be dynamically loaded and matched.

Suggestion syntax:

.. collection:: AD-APARD32690-SL

   hdl:
     projects/ad738x_fmc/index

   linux:
     iio/driver/ad9078

   no-OS:
     projects/ad7091r8-sdz

User visiting pages that belong to a collection, will see the collections that the page belong to in the sidebar:

Image

Image

If many collections are available, some may be in the collapsed state. Also have minor highlight for the current page in the collection, indicating "you are here", don't make it clickable, because the user may be in a sub-page.
an entry projects/ad738x_fmc includes all pages inside the path, with index inferred as top-level (assert if exists with interrsphinx?), while projects/ad738x_fmc/index will show on index page only.
As in the screenshot, the naming label will be automatic, unless using the Some name <path/to/page> toctree style overwrite.

In it's backend, does it need to use interphinx at all? or just use doc paths? Use it as assertion only? or resolve refs into doc path?

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions