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

Revamp API docs #2616

Merged
merged 7 commits into from Nov 28, 2012
Merged

Revamp API docs #2616

merged 7 commits into from Nov 28, 2012

Conversation

takluyver
Copy link
Member

This makes the API docs shorter and (hopefully) more useful.

  • Don't add inheritance diagrams to all modules. I've manually added them to the docstrings where I think they're useful.
  • Don't include undocumented and inherited members in class documentation. Links to base classes are still included.
  • Use fewer subheadings, so the overview on this page is shorter. Classes can still be found in the index.
  • Add an @undoc decorator to exclude classes and functions from the documentation.

Alternative to #2383. This should require much less manual maintenance than that one would.

@takluyver
Copy link
Member Author

This also reduces the number of errors showing up while building the docs, because we're not trying to document __init__ for classes that don't have it.

@takluyver
Copy link
Member Author

On the grounds that no-one's ever interested in docs, I'll put a soft deadline on this: if no-one objects by Thursday, I'll merge it.

@Carreau
Copy link
Member

Carreau commented Nov 27, 2012

It's ok for me if you want to merge earlier.

bfroehle added a commit that referenced this pull request Nov 28, 2012
@bfroehle bfroehle merged commit b49156e into ipython:master Nov 28, 2012
@Carreau Carreau mentioned this pull request Dec 4, 2012
mattvonrocketstein pushed a commit to mattvonrocketstein/ipython that referenced this pull request Nov 3, 2014
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

Successfully merging this pull request may close these issues.

None yet

3 participants