Georg Brandl
f6cb763ff8
#564 : Add :confval:autodoc_docstring_signature which retrieves the signature from the first line of the docstring, if it is found there.
2011-01-03 22:51:33 +01:00
Georg Brandl
594c1a90f4
#520 : Provide `special-members` option for autodoc directives.
2011-01-03 21:56:41 +01:00
Georg Brandl
92cb77a131
#176 : Provide `private-members` option for autodoc directives.
2011-01-03 21:48:37 +01:00
Chris Rebert
ef62d317e5
autodoc's docstring/special-comment detection works for instance attributes too
2010-10-02 00:05:59 -07:00
Georg Brandl
7518d19437
#469 : document __all__ ordering in members.
2010-08-05 18:59:04 +02:00
Georg Brandl
580e1c90d3
#481 , #482 : fix `.name` reference matching.
...
#482 : When doing a non-exact search, match only the given type of object.
#481 : Apply non-exact search for Python reference targets with ``.name`` for modules too.
2010-08-05 13:39:23 +02:00
Georg Brandl
f4f3066581
Use the new rst domain in the sphinx docs.
2010-04-17 10:39:51 +02:00
Georg Brandl
1ea64352fe
A bit more tutorial.
2010-03-14 19:46:54 +01:00
Georg Brandl
a31e7e2f5d
#187 : Added support for source ordering of members in autodoc, with `autodoc_member_order = 'bysource'`.
2010-02-28 11:39:13 +01:00
Georg Brandl
fab92b215a
Added `autodoc_default_flags` config value, which can be used
...
to select default flags for all autodoc directives.
2010-02-21 22:16:06 +01:00
Georg Brandl
290a623669
Note that member docstrings need to be reST as well.
2009-09-09 19:10:24 +02:00
Georg Brandl
87cf9675c8
Fix markup.
2009-09-09 18:27:59 +02:00
Georg Brandl
c3b8e3fdf0
Clarify docs of automodule options.
2009-09-09 18:26:59 +02:00
Georg Brandl
269345a0f3
Clarify and fix typo.
2009-06-16 21:19:15 +02:00
Georg Brandl
e517911ac3
Autodoc can now exclude single members from documentation
...
via the ``exclude-members`` option.
2009-03-15 23:52:48 +01:00
Georg Brandl
d2d3606158
Autodoc can now order members either alphabetically (like previously) or by member type;
...
configurable either with the config value ``autodoc_member_order`` or a ``member-order`` option per directive.
Also fix a bug that documented module-level functions as attributes.
2009-02-27 15:48:41 +01:00
Georg Brandl
dd32405563
Remove docs for removed automodule_skip_lines setting.
2009-02-27 15:22:45 +01:00
Georg Brandl
10c89799fd
Fix #93 : note that show-inheritance works with automodule.
2009-02-15 18:52:28 +01:00
Georg Brandl
55c4f5a096
merge with trunk
2009-01-22 19:25:24 +01:00
Georg Brandl
29cc19a199
merge with 0.5
2009-01-22 19:23:23 +01:00
Georg Brandl
05cf79da52
A bit of clarification about where Sphinx finds autodoced modules.
2009-01-22 19:22:49 +01:00
Georg Brandl
aedbdd953d
Fix more line length and trailing whitespace.
2009-01-10 22:18:18 +01:00
Georg Brandl
34a08b862e
Document how autodoc with attributes works.
2009-01-06 00:28:29 +01:00
Georg Brandl
155411a93d
Allow skipping members by event.
2008-11-02 20:04:24 +00:00
Georg Brandl
b4f91a5ce5
#3422 : allow changing the signature of functions via a new hook.
2008-07-29 18:30:23 +00:00
Georg Brandl
aa74c0b799
automodule now supports module options.
2008-07-08 14:45:44 +00:00
Georg Brandl
2e698fcb09
Merged revisions 64642-64643,64698 via svnmerge from
...
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x
........
r64642 | georg.brandl | 2008-07-01 23:02:35 +0200 (Tue, 01 Jul 2008) | 2 lines
#3251 : label names are case insensitive.
........
r64643 | georg.brandl | 2008-07-01 23:24:55 +0200 (Tue, 01 Jul 2008) | 2 lines
Add a note about decorated functions.
........
r64698 | georg.brandl | 2008-07-04 12:21:09 +0200 (Fri, 04 Jul 2008) | 2 lines
Allow setting current module to None.
........
2008-07-04 14:27:25 +00:00
Georg Brandl
c1bedfc105
Add general docstring processing support with a new event in autodoc.
2008-06-22 21:02:50 +00:00
Georg Brandl
7c2247f880
Support :noindex: in autodoc directives.
2008-06-22 17:58:05 +00:00
Georg Brandl
309377fbbf
Support inheritance display in autoclass, thanks to mdboom.
2008-06-17 09:24:11 +00:00
Georg Brandl
0e3dd509e6
Clarify docs for auto directive options.
2008-05-23 13:57:48 +00:00
Georg Brandl
0bcc9d4655
Minor enhancements to generate_rst.
2008-05-06 18:23:36 +00:00
Armin Ronacher
6e0c582a7b
added support for explicit signatures in callables
2008-05-06 18:07:17 +00:00
Georg Brandl
5ed30072e3
Rename version to 0.3.
2008-05-04 17:57:11 +00:00
Georg Brandl
d93b236545
#2726 : allow selecting what gets inserted into an autoclass directive.
2008-05-04 09:37:37 +00:00
Georg Brandl
a9d35e3c54
#2656 : autodoc now skips inherited members unless the :inherited-members: flag is given.
2008-05-04 09:07:51 +00:00
Georg Brandl
2571218ab9
Add note about __module__ checking.
2008-04-13 08:09:07 +00:00
Georg Brandl
f2d713c577
Add documentation for autodoc.
2008-03-14 23:35:08 +00:00
Georg Brandl
6d7d1f6e50
Some more documentation.
2008-03-12 21:37:22 +00:00
