Commit Graph

20 Commits

Author SHA1 Message Date
Stefan van der Walt 633bb7fa52 Pick up Cython functions when building docs API 2015-04-11 23:59:57 -07:00
Stefan van der Walt 9bfaaa4280 apigen: Fix function detection in Python 3 2014-12-16 14:41:34 +02:00
Stefan van der Walt 13440966ea Merge pull request #1277 from emmanuelle/api_layout
In API docs page, place table of contents at the top
2014-12-15 02:26:07 +02:00
Steven Silvester bd94253cef Add python3 doc building capability 2014-12-13 11:59:22 -06:00
emmanuelle 5cb2c630a4 Modified the order of API docs page so that table of contents is always
at the top (following #880)
2014-12-13 13:31:36 +01:00
François Boulogne eb9de1d7eb MIN: use print() instead of print 2013-06-12 21:16:23 +02:00
Tony S Yu 7a90420d9c DOC: Change algorithm for depth of API generation
Previously, apigen documented all but the bottom-most level of modules in the package tree. This caused problems when different subpackages had different depths. Instead, just document subpackages (ignore python files, whose public functions should already be loaded into the subpackage).
2012-10-02 00:38:56 -04:00
Tony S Yu 0643b8108f DOC: Remove commented out code. 2012-09-02 17:53:22 -04:00
Tony S Yu e6ca084aee DOC: Remove inherited-members Sphinx role.
Documenting inherited methods and attributes can lead to overly verbose docs. For example, the `Image` class, which subclasses ndarray, and various viewer-related classes, which subclass PyQt and Matplotlib classes, have hundreds of irrelevant methods added to the API docs.
2012-09-02 17:53:22 -04:00
Tony S Yu 0a92bf84e1 DOC: Remove inheritance-diagram Sphinx role.
Either the role should be removed (as done here) or the inheritance-diagram extension needs to be added to the config file. Since skimage doesn't have a complicated class hierarchies, it's probably best to remove.
2012-09-02 17:53:22 -04:00
emmanuelle 6d67bba941 Renaming: scikits.image -> skimage 2011-10-18 21:12:27 +02:00
Tony S Yu f763b6ce3c Fix import in apigen.py, which fails when other scikits are present.
__import__ can get confused about which scikits path to import when multiple scikits are present on a system.

Note that `root_module` is no longer an attribute of `ApiDocWriter` (it wasn't being used anywhere), and it now points to "scikits.image" instead of "scikits".
2011-07-15 20:14:15 +02:00
Pieter Holtzhausen de74356bbf Added destination to Makefile and fixed doc system 2011-07-15 20:14:15 +02:00
Stefan van der Walt 96efa2a6a5 Docs: In API generator, also recognise extensions. 2009-10-17 12:56:46 +02:00
Ralf Gommers 20031dae08 Fix up API generation.
It uses introspection now instead of parsing the text of .py files.
2009-10-16 11:08:34 +02:00
Ralf Gommers 04b1f3bffb Use same bullet level for functions and classes. 2009-10-16 11:08:34 +02:00
Ralf Gommers 0df02263a1 Clean up title of API reference. 2009-10-16 11:08:34 +02:00
Ralf Gommers c6565e6a56 Remove "Functions" links/headings.
Also some whitespace issues in this file.
2009-10-16 11:08:34 +02:00
Stefan van der Walt 0452388ef0 Generate cleaner API reference with autosummary tables. 2009-09-24 17:50:31 +02:00
Stefan van der Walt 8c45ca5f54 Add API generation and fix documentation build. 2009-09-24 12:03:48 +02:00