Skip to content

Enhance TOC in docs #715

@111pontes

Description

@111pontes

The table of contents (TOC) for a class documentation only includes child classes:
image

Given that the class attributes aren't sorted alphabetically, it is important to have a TOC that lists alphabetically both class and leaf attributes. Furthermore, it is desirable to provide three TOCs:

  • TOC listing list keys in alphabetical order (only if the class specifies a list and the list has keys)
  • TOC listing "Leaf Attributes" in alphabetical order
  • TOC listing "Class Attributes" in alphabetical order

TOCs should have local hyper-links and not redirect to other pages.

Current structure makes it a bit cumbersome to find leaf attributes for classes with a large number of attributes.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions