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

Add cross-links and Table of Contents to the API section of the docs #263

Open
rpgoldman opened this issue May 27, 2020 · 0 comments
Open
Milestone

Comments

@rpgoldman
Copy link

The API section of the existing docs is hard to navigate, because you get a reference to a class (e.g., ModuleDefinition) when you are reading about some other class, and there is no way to chase that reference, except through string search (Cmd-F or Ctrl-F), which often gives a ton of false positives in that page (e.g., "ModuleDefinition" is mentioned a lot).

If you are using Sphinx, I think it will do all this for you, if you ask it to.

@tcmitchell tcmitchell added this to the 1.1 milestone Jun 5, 2020
@jakebeal jakebeal modified the milestones: 1.1, 1.2 Jul 9, 2020
@tcmitchell tcmitchell modified the milestones: 1.2, Future Tasks Oct 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants