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

Enhance TOC in docs #715

Closed
111pontes opened this issue Mar 20, 2018 · 0 comments
Closed

Enhance TOC in docs #715

111pontes opened this issue Mar 20, 2018 · 0 comments

Comments

@111pontes
Copy link
Collaborator

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.

@ghost ghost mentioned this issue Mar 23, 2018
@ghost ghost closed this as completed in #722 Mar 23, 2018
ghost pushed a commit that referenced this issue Mar 23, 2018
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant