Takayuki Shimizukawa
b3aa4aa81b
* In autodoc, fix display of parameter defaults containing backslashes. Closes #1502
2014-07-02 00:09:11 +09:00
Takayuki Shimizukawa
1d742bdcf5
* Fix exception on Python3 if nonexistent method is specified by automethod. Closes #1467
2014-06-09 01:43:34 +09:00
Georg Brandl
e030031321
Update copyright year.
2014-03-01 08:18:16 +01:00
Ben Darnell
b0ca105c36
Fix an exception introduced by b69b59480cba for __init__ with no docstring.
2014-01-20 11:54:51 -05:00
Takayuki Shimizukawa
e61f316c74
Fix autodoc with `autoclass_content="both" uses useless object.__init__ docstring when class does not have __init__`. Closes #1337
...
This caused by a change for #1138 .
2014-01-02 12:42:12 +09:00
Takayuki Shimizukawa
1d5c7d1f20
Fix: autodoc class __init__ override not removed from docstring. Closes #1138
2013-12-09 10:55:51 +00:00
Georg Brandl
ae8782178e
Test suite quickfix.
2013-09-16 09:45:56 +02:00
Georg Brandl
e732807869
Merged in JonnyJD/sphinx/autodoc_novalue (pull request #109 )
...
feature: autodoc: add :annotation: option for autodata and autoattribute
2013-09-16 04:25:53 +02:00
Georg Brandl
56ac8a19ee
test suite fixes
2013-04-01 15:11:18 +02:00
Georg Brandl
1af3e3ea71
tests: replace "from util import *" by explicit imports
2013-04-01 11:39:32 +02:00
Georg Brandl
9abf39f912
Fix overlong lines.
2013-03-31 15:44:04 +02:00
Johannes Dewender
649ab8030c
autodoc: change :novalue: to :annoation: option
...
The :novalue: option is now called :annotation: and has an additional feature:
When given with an argument, you can specify what the annotation
of the object will be.
2013-02-27 16:38:55 +01:00
Takayuki Shimizukawa
70f3f889d1
Fix autodoc crash if :members: and :special-members: ware both set (by d7ac5e4).
2013-02-03 22:27:20 +09:00
Takayuki Shimizukawa
e70a43a9c5
Closes #1062 : sphinx.ext.autodoc use __init__ method signature for class signature.
2013-02-03 20:27:34 +09:00
Takayuki Shimizukawa
4d4dad3610
test refactoring: use with_setup for all test_autodoc.py's tests
2013-02-03 13:53:10 +09:00
Takayuki Shimizukawa
e47f434c32
add test for pull request #111 : Respect add_autodoc_attrgetter() even when inherited-members is set
2013-02-03 12:48:39 +09:00
Johannes Dewender
ffb825d733
fix tests for autodoc novalue option
...
In the tests for autodoc the Options are of type struct,
while in the code there is a special autodoc.Options class,
which is a dict.
So "novalue" in self.options doesn't work,
but self.options.novalue does work for both.
Additionally the logic for autoattribute was wrong and is fixed now.
2013-01-24 18:17:53 +01:00
Takayuki Shimizukawa
3a5277c14c
fix: autodoc documented descriptor class as attribute
2013-01-12 18:12:55 +09:00
Jonathan Waltman
bba6104b84
Issue #1069 : Add failing test for signature formatting of "partial" functions without kwargs.
2013-01-09 08:37:53 -06:00
Jonathan Waltman
42c90ee178
Add basic debugging support for autodoc.
2013-01-05 08:28:54 -06:00
Georg Brandl
151856819c
Copyright update.
2013-01-01 22:13:15 +01:00
Jonathan Waltman
6f9e541ab5
autodoc: Handle explicit instance attributes in :members: (re #904 )
2012-11-08 21:19:47 -06:00
Jonathan Waltman
bf362e9ccb
Closes #617 : Fix docstring preparation without included signature: only ignore indentation of one line, not two.
2012-09-16 01:08:47 -05:00
Georg Brandl
a63230f12d
#431 : Doc comments for attributes can now be given on the same line as the assignment.
2011-01-15 15:40:59 +01:00
Georg Brandl
dc0c43da9a
#437 : autodoc now shows values of class data attributes.
2011-01-08 23:45:58 +01:00
Łukasz Langa
48d64cc4cb
Support for autodocumenting partial functions.
2011-01-08 18:06:24 +01:00
Georg Brandl
5c39cfb6e9
merge with 1.0
2011-01-07 19:04:53 +01:00
Georg Brandl
b44e894125
Fix test_autodoc.
2011-01-07 19:03:44 +01:00
Georg Brandl
0d1a8e5720
merge with 1.0
2011-01-06 13:07:07 +01:00
Georg Brandl
8621526045
#568 : Fix lookup of class attribute documentation on descriptors so that comment documentation now works.
...
Needed to port assignment of ``self.parent`` from trunk.
2011-01-06 13:03:17 +01:00
Georg Brandl
17efae5622
merge with 1.0
2011-01-04 11:29:09 +01:00
Georg Brandl
0e1db6ad90
New year update.
2011-01-04 10:00:51 +01:00
Georg Brandl
8fd5bd1e19
Fix docstring preparation with included signature: ignore indentation of two lines when looking for the signature.
2011-01-04 00:04:04 +01:00
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
Georg Brandl
7c7d3f4010
Added `exclude argument to :func:.autodoc.between`. From http://bitbucket.org/mfperzel/sphinx-additions .
2010-06-12 18:16:18 +02: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
036a399011
merge with trunk
2010-02-27 23:14:19 +01:00
Georg Brandl
cee7e4ba3b
merge with 0.6
2010-02-21 23:20:26 +01:00
Georg Brandl
686824997d
In autodoc, allow customizing the signature of an object via autodoc-process-signature where the built-in mechanism fails.
2010-02-21 22:59:53 +01:00
Georg Brandl
c8ccbf9ce8
Fix test suite.
2010-01-18 00:41:34 +01:00
Georg Brandl
07f295df7c
merge
2010-01-13 23:35:13 +00:00
Georg Brandl
a52885d078
Fix the test suite.
2010-01-13 23:35:05 +00:00
Georg Brandl
54a31c5a6f
Change naming convention in doc_read_data to "domain:key".
2010-01-13 20:45:34 +01:00
Georg Brandl
cbd75346fd
merge with trunk
2010-01-07 19:17:45 +01:00
Georg Brandl
09147448d4
#280 : Autodoc can now document instance attributes assigned in `__init__` methods.
2010-01-03 13:59:30 +01:00
Georg Brandl
faeec5cbbb
merge with trunk
2010-01-02 21:03:56 +01:00
Georg Brandl
f6a56192d1
Happy new year!
2010-01-01 14:09:13 +01:00
Georg Brandl
3594104d4e
merge with trunk
2009-10-26 14:05:45 +01:00
