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

Make API docs easier to navigate #104

Open
bitprophet opened this issue Aug 19, 2011 · 0 comments
Open

Make API docs easier to navigate #104

bitprophet opened this issue Aug 19, 2011 · 0 comments

Comments

@bitprophet
Copy link
Member

Description

  • Autodoc detail pages are not always alphabetical, which sucks.
  • Also on autodoc detail pages: see if there's a way to list autodoc'd functions in a sidebar or top-of-page nav menu. It's very annoying to have to scroll through the page looking for the function in question!
  • See if there is a way for an "enhanced" toctree on the docs index page for the API/contrib sections. Need to indicate what is in those sections -- titles are not sufficient.

Originally submitted by Jeff Forcier (bitprophet) on 2009-11-11 at 11:50pm EST

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