Commit message (Collapse) | Author | Age | Files | Lines | ||
---|---|---|---|---|---|---|
... | ||||||
| | | * | Fix #5436: Autodoc does not work with enum subclasses with properties/methods | Takeshi KOMIYA | 2018-09-18 | 1 | -0/+6 | |
| | | | | ||||||
| | | * | test: Move EnumCls to target.enum package | Takeshi KOMIYA | 2018-09-18 | 1 | -15/+14 | |
| | | | | ||||||
| | * | | Fix #5431: autodoc: ``autofunction`` emits a warning for callable objects | Takeshi KOMIYA | 2018-09-18 | 1 | -0/+13 | |
| | |/ | ||||||
* | | | Remove unnecessary object from class definitions | Jon Dufresne | 2018-09-11 | 1 | -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 KOMIYA | 2018-09-09 | 1 | -25/+42 | |
|\ \ | |/ | ||||||
| * | Fix #5290: autodoc: failed to analyze source code in egg package | Takeshi KOMIYA | 2018-09-06 | 1 | -0/+23 | |
| | | ||||||
| * | Fix #2401: autodoc: ``:members:`` causes ``:special-members:`` not to be shown | Takeshi KOMIYA | 2018-09-03 | 1 | -25/+19 | |
| | | ||||||
* | | Drop APIs deprecated in 2.0 | Takeshi KOMIYA | 2018-09-03 | 1 | -4/+4 | |
|/ | ||||||
* | Merge pull request #5315 from tk0miya/add_autodoc_default_options | Takeshi KOMIYA | 2018-08-20 | 1 | -34/+25 | |
|\ | | | | | Add autodoc_default_options | |||||
| * | Add autodoc_default_options | Takeshi KOMIYA | 2018-08-18 | 1 | -34/+25 | |
| | | ||||||
* | | Merge branch '1.7' | Takeshi KOMIYA | 2018-08-19 | 1 | -0/+38 | |
|\ \ | |/ |/| | ||||||
| * | Fix #5211: autodoc: No docs generated for functools.partial functions | Takeshi KOMIYA | 2018-08-17 | 1 | -0/+38 | |
| | | ||||||
* | | autodoc: add 'exclude-members' to user global options | Lewis Haley | 2018-08-17 | 1 | -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 arguments | Lewis Haley | 2018-08-17 | 1 | -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_autodoc | Lewis Haley | 2018-08-17 | 1 | -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 testcase | Takeshi KOMIYA | 2018-08-05 | 1 | -37/+0 | |
| | | ||||||
* | | refactor: test_autodoc | Takeshi KOMIYA | 2018-08-05 | 1 | -143/+240 | |
| | | ||||||
* | | Add testcases for autodoc_default_flags | Takeshi KOMIYA | 2018-07-28 | 1 | -20/+42 | |
| | | ||||||
* | | Fix flake8 violations on tests | Takeshi KOMIYA | 2018-07-28 | 1 | -1/+0 | |
| | | ||||||
* | | test: Validate whole of generated docs by autodoc | Takeshi KOMIYA | 2018-07-28 | 1 | -150/+533 | |
| | | ||||||
* | | test: Add do_autodoc() helper | Takeshi KOMIYA | 2018-07-28 | 1 | -13/+16 | |
| | | ||||||
* | | Close #2820: autoclass directive supports nested class | Takeshi KOMIYA | 2018-07-22 | 1 | -0/+3 | |
|/ | ||||||
* | Fix #5139: autodoc: Enum argument missing if it shares value with another | Takeshi KOMIYA | 2018-07-15 | 1 | -1/+2 | |
| | ||||||
* | Fix #4543: testcase for partialmethod is failed with py3.6.5 | Takeshi KOMIYA | 2018-04-08 | 1 | -1/+4 | |
| | ||||||
* | Fix #4769: autodoc loses the first staticmethod parameter | Takeshi KOMIYA | 2018-03-24 | 1 | -1/+1 | |
| | ||||||
* | test: Suppress DeprecationWarning | Takeshi KOMIYA | 2018-03-20 | 1 | -8/+11 | |
| | ||||||
* | Fix #4543: test for autodoc fails with python 3.5.3 | Takeshi KOMIYA | 2018-03-13 | 1 | -1/+1 | |
| | ||||||
* | Fix flake8 violations | Takeshi KOMIYA | 2018-02-19 | 1 | -3/+2 | |
| | ||||||
* | Fix #4539: autodoc emits warnings for partialmethods | Takeshi KOMIYA | 2018-02-04 | 1 | -0/+47 | |
| | ||||||
* | Fix #4415: autodoc classifies inherited staticmethods as regular methods | Takeshi KOMIYA | 2018-01-20 | 1 | -0/+2 | |
| | ||||||
* | Fix #4415: autodoc classifies inherited classmethods as regular methods | Takeshi KOMIYA | 2018-01-20 | 1 | -0/+2 | |
| | ||||||
* | Merge branch 'master' into dont_emit_system_message_on_autodoc_warning | Takeshi KOMIYA | 2018-01-08 | 1 | -319/+112 | |
|\ | ||||||
| * | Deprecate sphinx.ext.autodoc.add_documenter() and AutoDirective._register | Takeshi KOMIYA | 2018-01-01 | 1 | -11/+11 | |
| | | ||||||
| * | Merge branch 'happy_new_year' into master | Takeshi KOMIYA | 2018-01-01 | 1 | -1/+1 | |
| |\ | ||||||
| | * | A happy new year! | Takeshi KOMIYA | 2018-01-01 | 1 | -1/+1 | |
| | | | ||||||
| * | | Fix flake8 violations | Takeshi KOMIYA | 2017-12-23 | 1 | -1/+1 | |
| | | | ||||||
| * | | Fix broken test_autodoc | Takeshi KOMIYA | 2017-12-22 | 1 | -3/+2 | |
| | | | ||||||
| * | | Merge branch 'master' into ignore__all__ | Takeshi KOMIYA | 2017-12-22 | 1 | -306/+93 | |
| |\ \ | ||||||
| | * | | test_autodoc: Separate testdata (python objects) and testcases | Takeshi KOMIYA | 2017-12-21 | 1 | -306/+93 | |
| | | | | ||||||
| * | | | Closes #947: autodoc now supports ignore-module-all to ignore a module's __all__ | Kevin Keating | 2017-12-20 | 1 | -0/+7 | |
| |/ / | ||||||
* | | | autodoc: Use logging module to emit warnings | Takeshi KOMIYA | 2017-12-20 | 1 | -18/+20 | |
|/ / | ||||||
* | | deprecate formatargspec() and format_annotation() | Takeshi KOMIYA | 2017-12-17 | 1 | -50/+0 | |
| | | ||||||
* | | Merge branch 'stable' | Takeshi KOMIYA | 2017-09-24 | 1 | -1/+4 | |
|\ \ | |/ | ||||||
| * | Fix #3969: private instance attributes causes AttributeError | Takeshi KOMIYA | 2017-07-31 | 1 | -1/+4 | |
| | | ||||||
* | | Basic test for docstring inheritance | Antonio Valentino | 2017-08-19 | 1 | -0/+13 | |
| | | ||||||
* | | Replace getargspec by Signature class in autodoc module | Takeshi KOMIYA | 2017-06-17 | 1 | -1/+1 | |
|/ | ||||||
* | refs #3458: add sphinx.testing that are moved from /tests directory. | shimizukawa | 2017-05-14 | 1 | -6/+8 | |
| | ||||||
* | Merge pull request #3449 from njsmith/getargspec-__wrapped__ | Takayuki SHIMIZUKAWA | 2017-04-19 | 1 | -1/+7 | |
|\ | | | | | On py3, use inspect.signature for more accurate signature calculation | |||||
| * | Update test to match py3's more accurate signature | Nathaniel J. Smith | 2017-02-24 | 1 | -1/+7 | |
| | | ||||||
* | | Year++ | Takeshi KOMIYA | 2017-03-26 | 1 | -1/+1 | |
|/ |