summaryrefslogtreecommitdiff
path: root/sphinx/ext/autodoc.py
Commit message (Collapse)AuthorAgeFilesLines
* Update copyright year.Georg Brandl2014-03-011-6/+39
|\
| * MergeDmitry Shachnev2014-01-221-2/+3
| |\
| | * Fix an exception introduced by b69b59480cba for __init__ with no docstring.Ben Darnell2014-01-201-2/+3
| | |
| * | MergeDmitry Shachnev2014-01-201-4/+4
| |\ \ | | |/ | |/|
| | * Modernize the code now that Python 2.5 is no longer supportedDmitry Shachnev2014-01-191-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - Use print function instead of print statement; - Use new exception handling; - Use in operator instead of has_key(); - Do not use tuple arguments in functions; - Other miscellaneous improvements. This is based on output of `futurize --stage1`, with some manual corrections.
| * | mock: little changes, changelog and versionaddedGeorg Brandl2014-01-191-10/+11
| | |
| * | Merged in guibog/sphinx2 (pull request #184)Georg Brandl2014-01-191-0/+32
| |\ \ | | |/ | |/| | | | autodoc extension: add autodoc_mock_imports config value
| | * autodoc extension: add autodoc_mock_imports config valueguibog2013-10-231-0/+32
| | |
| * | merge headsshimizukawa2014-01-151-6/+16
| |\ \
| * | | Drop python-2.5 and remove 2.4,2.5 support codesshimizukawa2013-12-151-2/+2
| | | |
* | | | Update copyright year.Georg Brandl2014-03-011-1/+1
| | | |
* | | | Fix an exception introduced by b69b59480cba for __init__ with no docstring.Ben Darnell2014-01-201-2/+3
| |/ / |/| |
* | | Fix pypy test failure for b69b594 commit. refs #1337shimizukawa2014-01-151-1/+2
| | |
* | | Closes #1155: Fix autodocumenting C-defined methods as attributes in Python 3.Georg Brandl2014-01-121-1/+2
| | |
* | | Closes #1181: Report option errors in autodoc directives more gracefully.Georg Brandl2014-01-121-2/+9
| | |
* | | Closes #932: autodoc: Do not crash if ``__doc__`` is not a string.Georg Brandl2014-01-101-1/+2
| | |
* | | Closes #814: autodoc: Guard against strange type objects that don't haveGeorg Brandl2014-01-101-1/+1
| | | | | | | | | | | | ``__bases__``.
* | | Fix autodoc with ``autoclass_content="both"`` uses useless ↵shimizukawa2014-01-021-1/+1
|/ / | | | | | | | | | | ``object.__init__`` docstring when class does not have ``__init__``. Closes #1337 This caused by a change for #1138.
* | Fix: autodoc class __init__ override not removed from docstring. Closes #1138shimizukawa2013-12-091-2/+12
| |
* | Merged in shimizukawa/sphinx-fix-pypytest (pull request #177)Takayuki Shimizukawa2013-12-091-3/+8
|\ \ | |/ |/| | | Fix PyPy test failed
| * Now sphinx.ext.autodoc on PyPy ignoring the method of built-in classes.shimizukawa2013-10-071-3/+8
| | | | | | | | | | | | | | | | | | | | | | For example:: class CustomDict(dict): """Docstring.""" From this code, autoclass directive on PyPy generate a document output as ``class foo.CustomDict(obj, *args, **keywords)`` instead of ``class foo.CustomDict`` before this change.
* | autodoc: fix annotation None for propertiesJohannes Dewender2013-10-091-7/+8
|/ | | | | This is a follow-up for pull request #109 / bdb3fadacd96cc9019440f2b3aad74f9c72b0500
* Merged in Vladimirsson/sphinx (pull request #136)Georg Brandl2013-09-161-0/+4
|\ | | | | | | Added ``imported-members`` option for ``automodule`` directive in autodoc
| * Added ``imported-members`` option for ``automodule`` directive in autodocBogdan Opanchuk2013-04-201-0/+4
| |
* | Merged in JonnyJD/sphinx/autodoc_novalue (pull request #109)Georg Brandl2013-09-161-5/+29
|\ \ | |/ |/| | | feature: autodoc: add :annotation: option for autodata and autoattribute
| * autodoc: change :novalue: to :annoation: optionJohannes Dewender2013-02-271-6/+25
| | | | | | | | | | | | 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.
| * fix tests for autodoc novalue optionJohannes Dewender2013-01-241-2/+2
| | | | | | | | | | | | | | | | | | | | | | 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.
| * autodoc: novalue option for autodata and autoattributeJohannes Dewender2013-01-221-7/+12
| | | | | | | | | | | | This adds a ":novalue:" option to "autodata" and "autoattribute" from the autodoc extension. When the option is set, no value will be in the output.
* | Fix autodoc crash if :members: and :special-members: ware both set (by d7ac5e4).shimizukawa2013-02-031-0/+1
| |
* | Closes #1062: sphinx.ext.autodoc use __init__ method signature for class ↵shimizukawa2013-02-031-0/+12
| | | | | | | | signature.
* | Respect add_autodoc_attrgetter() even when inherited-members is setA. Jesse Jiryu Davis2013-01-311-1/+1
|/
* autodoc: debug module analyzer failureGeorg Brandl2013-01-131-1/+2
|
* fix: autodoc documented descriptor class as attributeshimizukawa2013-01-121-1/+1
|
* autodoc: use debug2() and [autodoc] prefixGeorg Brandl2013-01-121-11/+11
|
* autodoc: Don't rely on reporter.get_source_and_line existing for debug messages.Jonathan Waltman2013-01-051-1/+4
|
* Add basic debugging support for autodoc.Jonathan Waltman2013-01-051-6/+24
|
* Copyright update.Georg Brandl2013-01-011-1/+1
|
* autodoc: Handle explicit instance attributes in :members: (re #904)Jon Waltman2012-11-081-14/+17
|
* Fix test_autodoc with Python 3.3, patches by Jon and Takayuki.Georg Brandl2012-11-011-1/+1
|
* merge with stableGeorg Brandl2012-10-281-3/+7
|\
| * Changed the ``special-members`` option to behave like the ``members`` option.ms4py2012-03-161-3/+7
| |
* | Closes #617: Fix docstring preparation without included signature: only ↵Jon Waltman2012-09-161-1/+4
|/ | | | ignore indentation of one line, not two.
* Fixes #836: catch AttributeError when retrieving __dict__ attribute.Georg Brandl2012-03-101-3/+7
|
* Correctly treat built-in method (method descriptors) as methodsJulian Andres Klode2011-05-041-1/+2
| | | | | | | This fixes a bug where method descriptors were treated as data descriptors. As the builtin_method_descriptor type is not exported anywhere in Python, we check for the name here. As we know that it is a descriptor, this should not be a problem.
* Fix #718: "pass" is not a good way to exit a function.Georg Brandl2011-09-211-1/+1
|
* Closes #671: new autodoc features: :special-members: and :private-members: ↵Georg Brandl2011-05-151-17/+31
| | | | should respect :undoc-members:. Also :special-members: should not document __doc__.
* Make check.Georg Brandl2011-01-151-1/+2
|
* #437: autodoc now shows values of class data attributes.Georg Brandl2011-01-081-5/+50
|
* merge with https://bitbucket.org/langacore/sphinxGeorg Brandl2011-01-081-2/+2
|\
* | Removed unnecessary \?ukasz Langa2011-01-081-1/+1
| |
View Lorry Controller Status