ipython/ipython — pull request #2383 by takluyver (2012-09-04 23:20:14+00:00)
Title: Apidocs

Not ready for merge.

This is something we discussed briefly a couple of weeks ago - should we move from fully auto-generated API docs to something a bit more manual, forcing us to be clearer about what is the public API?

I made a start towards that, but I wanted to check what we think of the idea and the details before I spend more time on it. I used the auto-generated API docs with some modifications:

- Rearranged into a hierarchical structure matching the package structure (`core/history.txt` rather than `IPython.core.history.txt`)
- Simplifying subheadings
- Not describing local utility functions and classes (like `Bunch`).
- Removing inheritance diagrams except where they're interesting (e.g. that for `ultratb` is interesting)
- Removing the `:inherited-members:` option from autoclass documentation (classes that derive from Configurable, for example, inherit a lot of confusing methods)
- Removing the `.. automethod:: __init__` documentation where `__init__` doesn't have a docstring.