summaryrefslogtreecommitdiff
path: root/tests/test_autodoc.py
Commit message (Collapse)AuthorAgeFilesLines
...
| | | * Fix #5436: Autodoc does not work with enum subclasses with properties/methodsTakeshi KOMIYA2018-09-181-0/+6
| | | |
| | | * test: Move EnumCls to target.enum packageTakeshi KOMIYA2018-09-181-15/+14
| | | |
| | * | Fix #5431: autodoc: ``autofunction`` emits a warning for callable objectsTakeshi KOMIYA2018-09-181-0/+13
| | |/
* | | Remove unnecessary object from class definitionsJon Dufresne2018-09-111-5/+5
|/ / | | | | | | | | In Python 3, all classes are new-style classes. The object in the definition is redundant and unnecessary.
* | Merge branch '1.8'Takeshi KOMIYA2018-09-091-25/+42
|\ \ | |/
| * Fix #5290: autodoc: failed to analyze source code in egg packageTakeshi KOMIYA2018-09-061-0/+23
| |
| * Fix #2401: autodoc: ``:members:`` causes ``:special-members:`` not to be shownTakeshi KOMIYA2018-09-031-25/+19
| |
* | Drop APIs deprecated in 2.0Takeshi KOMIYA2018-09-031-4/+4
|/
* Merge pull request #5315 from tk0miya/add_autodoc_default_optionsTakeshi KOMIYA2018-08-201-34/+25
|\ | | | | Add autodoc_default_options
| * Add autodoc_default_optionsTakeshi KOMIYA2018-08-181-34/+25
| |
* | Merge branch '1.7'Takeshi KOMIYA2018-08-191-0/+38
|\ \ | |/ |/|
| * Fix #5211: autodoc: No docs generated for functools.partial functionsTakeshi KOMIYA2018-08-171-0/+38
| |
* | autodoc: add 'exclude-members' to user global optionsLewis Haley2018-08-171-0/+52
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | As the previous commit explains, it is now possible to specify arguments to the global options in config files. This means that we can now include the `exclude-members` option in this global configuration. Previously, there was no point including this option because it makes no sense without arguments. Including this option means users have the flexibility of explicitly including which special methods they want using (e.g.): :special-members: __init__, __iter__ or explicitly excluding which special-members (or other members) they want using (e.g.): :exclude-members: __weakref__, __hash__
* | autodoc: allow specifying values to global argumentsLewis Haley2018-08-171-5/+82
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Previously, users could specify a *list* of flags in their config files. The flags were directive names that would otherwise be present in the .rst files. However, as a list, it was not possible to specify values to those flags, which *is* possible in .rst files. For example, in .rst you could say :special-members: __init__, __iter__ And this would cause autodoc to generate documents for these methods that it would otherwise ignore. This commit changes the config option to instead accept a dictionary. This is a dictionary whose keys can contain the same flag-names as before, but whose values can contain the arguments as seen in .rst files. The old list is still supported, for backwards compatibility, but the data is transformed into a dictionary when the user's config is loaded.
* | test_autodoc: fix mutable function default argument in do_autodocLewis Haley2018-08-171-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | Setting mutable types as default arguments is bad practice because the value is only initialised once. This means that defaults arguments of lists and dictionaries which are modified during code execution *stay* modified between calls. In this case, the `options` dictionary accumulated options as more and more test cases were executed. Without this change, the tests added in the next commit do not pass. See: https://stackoverflow.com/questions/1132941/least-astonishment-and-the-mutable-default-argument
* | refactor: Remove duplicated testcaseTakeshi KOMIYA2018-08-051-37/+0
| |
* | refactor: test_autodocTakeshi KOMIYA2018-08-051-143/+240
| |
* | Add testcases for autodoc_default_flagsTakeshi KOMIYA2018-07-281-20/+42
| |
* | Fix flake8 violations on testsTakeshi KOMIYA2018-07-281-1/+0
| |
* | test: Validate whole of generated docs by autodocTakeshi KOMIYA2018-07-281-150/+533
| |
* | test: Add do_autodoc() helperTakeshi KOMIYA2018-07-281-13/+16
| |
* | Close #2820: autoclass directive supports nested classTakeshi KOMIYA2018-07-221-0/+3
|/
* Fix #5139: autodoc: Enum argument missing if it shares value with anotherTakeshi KOMIYA2018-07-151-1/+2
|
* Fix #4543: testcase for partialmethod is failed with py3.6.5Takeshi KOMIYA2018-04-081-1/+4
|
* Fix #4769: autodoc loses the first staticmethod parameterTakeshi KOMIYA2018-03-241-1/+1
|
* test: Suppress DeprecationWarningTakeshi KOMIYA2018-03-201-8/+11
|
* Fix #4543: test for autodoc fails with python 3.5.3Takeshi KOMIYA2018-03-131-1/+1
|
* Fix flake8 violationsTakeshi KOMIYA2018-02-191-3/+2
|
* Fix #4539: autodoc emits warnings for partialmethodsTakeshi KOMIYA2018-02-041-0/+47
|
* Fix #4415: autodoc classifies inherited staticmethods as regular methodsTakeshi KOMIYA2018-01-201-0/+2
|
* Fix #4415: autodoc classifies inherited classmethods as regular methodsTakeshi KOMIYA2018-01-201-0/+2
|
* Merge branch 'master' into dont_emit_system_message_on_autodoc_warningTakeshi KOMIYA2018-01-081-319/+112
|\
| * Deprecate sphinx.ext.autodoc.add_documenter() and AutoDirective._registerTakeshi KOMIYA2018-01-011-11/+11
| |
| * Merge branch 'happy_new_year' into masterTakeshi KOMIYA2018-01-011-1/+1
| |\
| | * A happy new year!Takeshi KOMIYA2018-01-011-1/+1
| | |
| * | Fix flake8 violationsTakeshi KOMIYA2017-12-231-1/+1
| | |
| * | Fix broken test_autodocTakeshi KOMIYA2017-12-221-3/+2
| | |
| * | Merge branch 'master' into ignore__all__Takeshi KOMIYA2017-12-221-306/+93
| |\ \
| | * | test_autodoc: Separate testdata (python objects) and testcasesTakeshi KOMIYA2017-12-211-306/+93
| | | |
| * | | Closes #947: autodoc now supports ignore-module-all to ignore a module's __all__Kevin Keating2017-12-201-0/+7
| |/ /
* | | autodoc: Use logging module to emit warningsTakeshi KOMIYA2017-12-201-18/+20
|/ /
* | deprecate formatargspec() and format_annotation()Takeshi KOMIYA2017-12-171-50/+0
| |
* | Merge branch 'stable'Takeshi KOMIYA2017-09-241-1/+4
|\ \ | |/
| * Fix #3969: private instance attributes causes AttributeErrorTakeshi KOMIYA2017-07-311-1/+4
| |
* | Basic test for docstring inheritanceAntonio Valentino2017-08-191-0/+13
| |
* | Replace getargspec by Signature class in autodoc moduleTakeshi KOMIYA2017-06-171-1/+1
|/
* refs #3458: add sphinx.testing that are moved from /tests directory.shimizukawa2017-05-141-6/+8
|
* Merge pull request #3449 from njsmith/getargspec-__wrapped__Takayuki SHIMIZUKAWA2017-04-191-1/+7
|\ | | | | On py3, use inspect.signature for more accurate signature calculation
| * Update test to match py3's more accurate signatureNathaniel J. Smith2017-02-241-1/+7
| |
* | Year++Takeshi KOMIYA2017-03-261-1/+1
|/