Provide the ability to show the table of contents for API members
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Currently, it's impossible to navigate between API members in docs using the ToC of the right.
For example, it would be convenient to see all msgpack members under the Index ToC entry.
Example from other docs (Docusaurus): https://reactnative.dev/docs/button.
The corresponding feature is added in the 5.2.0 Sphinx version (#6316).
The 5.2.3 adds the capability to disable this feature when required.
How to configure: https://github.com/sphinx-doc/sphinx/issues/6316#issuecomment-1257024499
doc-builder issue: https://github.com/tarantool/doc-builder/issues/22
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the linked Sphinx 5.2.0 and 5.2.3 release details, then inspect the linked tarantool/doc-builder issue for the integration point. Done means API members appear in the right-hand table of contents, with a documented way to disable the feature where needed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100