summaryrefslogtreecommitdiff
path: root/sphinx/ext/autodoc.py
Commit message (Collapse)AuthorAgeFilesLines
...
| * | Make sure to iterate obj_dict's keys using list, not viewGunWoo Choi2016-02-091-3/+4
| | | | | | | | | | | | | | | | | | In Python3 `dict.keys()` returns a view object not a list cherry-picked from master 22ce010e0 to stable for #2116.
| * | Closes #2295: Avoid mutating dictionary errors while enumerating members in ↵Georg Brandl2016-02-041-1/+1
| | | | | | | | | | | | autodoc with Python 3
* | | Merge pull request #2300 from akruis/feature_autoclass_content_from__new__Takeshi KOMIYA2016-02-141-0/+9
|\ \ \ | | | | | | | | Feature: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing of empty
| * | | Feature: enhance autoclass:: to use the docstring of __new__Anselm Kruis2016-02-051-0/+9
| |/ / | | | | | | | | | | | | | | | | | | | | | | | | The method new is an alternative to __init__, but autoclass does not respect __new__. This commit enhances the directive autoclass:: to try __new__ method's docstring, if __init__ method's docstring is missing or empty. The commit also adds tests and updates the documentation.
* | | Merge branch 'stable'Georg Brandl2016-01-171-3/+5
|\ \ \ | |/ /
| * | Closes #2243: ignore strange docstring types in class docs, like already ↵Georg Brandl2016-01-171-3/+5
| | | | | | | | | | | | done for method docs.
* | | Merge branch 'stable'Georg Brandl2016-01-141-1/+1
|\ \ \ | |/ /
| * | Obligatory copyright update.Georg Brandl2016-01-141-1/+1
| |/
* | Make sure to iterate obj_dict's keys using list, not viewGunWoo Choi2015-11-131-4/+4
| | | | | | In Python3 `dict.keys()` returns a view object not a list
* | Closes #1968: Show extended type hints for function annotations that use ↵Andrey Vlasovskikh2015-07-311-7/+129
|/ | | | 'typing' module
* Autodoc: Python2 Allow unicode string in __all__Jens Hedegaard Nielsen2015-03-161-2/+2
|
* Support PEP-440 version spec for developers.shimizukawa2015-03-141-1/+1
|
* ext: pep8 fixesGeorg Brandl2015-03-081-4/+6
|
* Remove non-determinismDmitry Shachnev2015-01-281-6/+11
| | | | | | | | | | | | | | To enable packages using Sphinx to build reproducibly, its output needs to be the same from one build to another. Its output now strips memory references such as: <__main__.A at 0x7f68cb685710> In addition, various generated files (objects.inv, searchindex.js, translations) are now written with their keys in a determinstic order. Based on a patch by Chris Lamb <lamby@debian.org>.
* #1674: do not crash if module.__all__ is not according to specGeorg Brandl2015-01-151-0/+9
|
* autodoc: use sourcename also for content generated by autodoc itselfLuc Saffre2015-01-061-20/+30
| | | | | Fixes #1061 Fixes #1656
* Merge branch 'stable'Georg Brandl2015-01-031-1/+1
|\
| * all: update copyrightGeorg Brandl2015-01-031-1/+1
| |
* | merge with stableGeorg Brandl2014-11-071-52/+36
|\ \ | |/
| * Fix :confval:`autodoc_docstring_signature` not working with signaturesGeorg Brandl2014-11-071-52/+36
| | | | | | | | in class docstrings.
| * Now sphinx.ext.autodoc work with python-2.5 again.Takayuki Shimizukawa2014-09-261-1/+1
| |
* | [WIP] parallel readGeorg Brandl2014-09-221-1/+1
| |
* | Change extension setup() return value to a dictionary of metadata.Georg Brandl2014-09-221-1/+1
| | | | | | | | This makes it possible to introduce more metadata values later.
* | autodoc: minor PEP8 adjustmentsGeorg Brandl2014-09-221-24/+35
| |
* | Handle more instances of "__builtin__".Georg Brandl2014-09-201-1/+1
| |
* | Move env.temp_data content that might be used to resolve references to a new ↵Georg Brandl2014-09-201-3/+3
| | | | | | | | env.ref_context dictionary.
* | Return version from setup() for all sphinx.ext extensions.Georg Brandl2014-09-031-0/+3
| |
* | merge with stableTakayuki Shimizukawa2014-07-131-4/+11
|\ \ | |/
| * * Fix: autodoc, autosummary: importing setup.py will invoke setup process ↵Takayuki Shimizukawa2014-07-051-3/+7
| | | | | | | | and execute `sys.exit()`. Now sphinx avoids SystemExit exception and emits warnings without unexpected termination. Closes #1226
| * * In autodoc, fix display of parameter defaults containing backslashes. ↵Takayuki Shimizukawa2014-07-021-1/+4
| | | | | | | | Closes #1502
* | * fix over 80 chars line and remove unused import.Takayuki Shimizukawa2014-06-151-1/+1
| |
* | Merged in shimizukawa/sphinx-remove-complex-method-distinguishing (pull ↵Takayuki Shimizukawa2014-06-151-36/+19
|\ \ | | | | | | | | | | | | | | | request #246) remove complex distinguishing method/classmethod/staticmethod approach for autodoc
| * | * remove PY3 importingTakayuki Shimizukawa2014-06-101-1/+1
| | |
| * | * remove complex distinguishing method/classmethod/staticmethod approachTakayuki Shimizukawa2014-06-091-35/+18
| | |
* | | * add test and code comment for pull request #157Takayuki Shimizukawa2014-06-141-1/+4
| | |
* | | Merged in David_Ham/sphinx (pull request #157)Takayuki Shimizukawa2014-06-141-1/+15
|\ \ \ | |/ / |/| | | | | Remove spurious signatures from @property decorated attributes
| * | mergeDavid Ham2014-03-281-6/+39
| |\ \
| * \ \ mergeDavid Ham2014-03-281-23/+78
| |\ \ \
| * | | | Create a derivative of the DocstringSignatureMixin which stripsDavid Ham2013-08-121-1/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | signature strings from attributes. This scenario can occur when using Cython and turning methods into attributes with an @property decorator.
* | | | | merge with stableTakayuki Shimizukawa2014-06-091-0/+4
|\ \ \ \ \ | | |_|_|/ | |/| | |
| * | | | * Fix exception on Python3 if nonexistent method is specified by automethod. ↵Takayuki Shimizukawa2014-06-091-0/+4
| | |/ / | |/| | | | | | | | | | Closes #1467
* | | | delegate '__nonzero__' to '__bool__' for py2/py3 compatibility in one ↵Takayuki Shimizukawa2014-05-011-1/+2
| | | | | | | | | | | | | | | | source. #1350
* | | | remove 'six' name except importing line.Takayuki Shimizukawa2014-04-301-6/+5
| | | |
* | | | use six privided text_type() to replace with unicode() to support py2/py3 in ↵Takayuki Shimizukawa2014-04-291-6/+6
| | | | | | | | | | | | | | | | one source. refs #1350.
* | | | use six privided iteritems(),itervalues() to support py2/py3 in one source. ↵Takayuki Shimizukawa2014-04-291-3/+4
| | | | | | | | | | | | | | | | refs #1350.
* | | | introduce the six module and reduce sphinx.util.pycompat implementation. ↵Takayuki Shimizukawa2014-04-291-5/+5
| |_|/ |/| | | | | | | | refs #1350.
* | | Update copyright year.Georg Brandl2014-03-011-1/+1
|\ \ \ | |/ /
| * | 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
| | |
* | | MergeDmitry Shachnev2014-01-221-4/+4
|\ \ \
View Lorry Controller Status