Lewis Haley
87029392fd
test_autodoc: fix mutable function default argument in do_autodoc
...
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
2018-08-17 15:33:58 +01:00
Takeshi KOMIYA
7e546c0e0b
refactor: Remove duplicated testcase
2018-08-05 08:18:21 +09:00
Takeshi KOMIYA
de73ee5902
refactor: test_autodoc
2018-08-05 08:18:21 +09:00
Takeshi KOMIYA
7ee868fb18
Add testcases for autodoc_default_flags
2018-07-28 22:37:32 +09:00
Takeshi KOMIYA
f969edfaa8
Fix flake8 violations on tests
2018-07-28 20:19:30 +09:00
Takeshi KOMIYA
c657f1c1c2
test: Validate whole of generated docs by autodoc
2018-07-28 18:46:13 +09:00
Takeshi KOMIYA
7dad01d18f
test: Add do_autodoc() helper
2018-07-28 18:30:27 +09:00
Takeshi KOMIYA
8c29801f27
Close #2820 : autoclass directive supports nested class
2018-07-22 01:06:17 +09:00
Takeshi KOMIYA
b1acc54cf9
Fix #5139 : autodoc: Enum argument missing if it shares value with another
2018-07-15 18:53:53 +09:00
Takeshi KOMIYA
aefb3bbaaa
Fix #4543 : testcase for partialmethod is failed with py3.6.5
2018-04-08 21:54:00 +09:00
Takeshi KOMIYA
9e0089b252
Fix #4769 : autodoc loses the first staticmethod parameter
2018-03-24 00:53:07 +09:00
Takeshi KOMIYA
049df5d5e1
test: Suppress DeprecationWarning
2018-03-20 20:27:05 +09:00
Takeshi KOMIYA
f2a23b761e
Fix #4543 : test for autodoc fails with python 3.5.3
2018-03-13 23:23:15 +09:00
Takeshi KOMIYA
f7027049b1
Fix flake8 violations
2018-02-19 23:20:56 +09:00
Takeshi KOMIYA
656e3be754
Fix #4539 : autodoc emits warnings for partialmethods
2018-02-04 23:23:43 +09:00
Takeshi KOMIYA
295323d5aa
Fix #4415 : autodoc classifies inherited staticmethods as regular methods
2018-01-20 01:10:47 +09:00
Takeshi KOMIYA
cbb10d61f7
Fix #4415 : autodoc classifies inherited classmethods as regular methods
2018-01-20 01:10:47 +09:00
Takeshi KOMIYA
326d7e64ce
Merge branch 'master' into dont_emit_system_message_on_autodoc_warning
2018-01-08 20:19:36 +09:00
Takeshi KOMIYA
5d6413b712
Deprecate sphinx.ext.autodoc.add_documenter() and AutoDirective._register
2018-01-01 12:13:29 +09:00
Takeshi KOMIYA
f1f6ca8cc9
Merge branch 'happy_new_year' into master
2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b
A happy new year!
2018-01-01 01:06:58 +09:00
Takeshi KOMIYA
a9efb2517a
Fix flake8 violations
2017-12-23 21:21:21 +09:00
Takeshi KOMIYA
e2e907b3ee
Fix broken test_autodoc
2017-12-22 00:53:53 +09:00
Takeshi KOMIYA
ffa9d48d0e
Merge branch 'master' into ignore__all__
2017-12-22 00:28:26 +09:00
Takeshi KOMIYA
ec240614d9
test_autodoc: Separate testdata (python objects) and testcases
2017-12-21 12:12:13 +09:00
Kevin Keating
e932ff5ad2
Closes #947 : autodoc now supports ignore-module-all to ignore a module's __all__
2017-12-20 15:07:33 -05:00
Takeshi KOMIYA
7a194f5296
autodoc: Use logging module to emit warnings
2017-12-20 01:40:45 +09:00
Takeshi KOMIYA
464f94c238
deprecate formatargspec() and format_annotation()
2017-12-17 15:25:44 +09:00
Takeshi KOMIYA
00169a07e6
Merge branch 'stable'
2017-09-24 22:51:23 +09:00
Antonio Valentino
96ee24d7c1
Basic test for docstring inheritance
2017-08-19 21:52:30 +02:00
Takeshi KOMIYA
13be8e03ba
Fix #3969 : private instance attributes causes AttributeError
2017-07-31 22:49:04 +09:00
Takeshi KOMIYA
27637d73e1
Replace getargspec by Signature class in autodoc module
2017-06-17 18:16:41 +09:00
shimizukawa
d497d74370
refs #3458 : add sphinx.testing that are moved from /tests directory.
2017-05-14 20:47:15 +09:00
Takayuki SHIMIZUKAWA
6cb582fdd3
Merge pull request #3449 from njsmith/getargspec-__wrapped__
...
On py3, use inspect.signature for more accurate signature calculation
2017-04-19 21:21:19 +09:00
Takeshi KOMIYA
c57e47e042
Year++
2017-03-26 11:49:34 +09:00
Nathaniel J. Smith
678eff821f
Update test to match py3's more accurate signature
2017-02-24 05:40:24 -08:00
Takeshi KOMIYA
cf2061dfad
Fix flake8 violations
2017-01-26 01:13:17 +09:00
shimizukawa
561abdd164
pytest optimizatoin:
...
- remote using deprecated decorators
- remove gen_with_app
- remove yield testing
- remove pytest warnings
- refactoring
2017-01-08 15:14:38 +09:00
shimizukawa
5b7d237db3
pytest migration
2017-01-04 00:59:30 +09:00
Takeshi KOMIYA
61a6ca5b37
Merge branch 'stable' into 1.5-release
2016-12-03 16:25:58 +09:00
shimizukawa
3284e89991
Merge branch 'fix-attr-documenter' into stable
2016-11-24 23:55:02 +09:00
Takeshi KOMIYA
4ca84aba45
Fix #3135 : `sphinx.ext.autodoc` crashes with plain Callable
2016-11-13 00:01:41 +09:00
Alex Grönholm
a1f6baaa81
Fix annotations formatting for plain typing.Callable
...
The typing.Callable class may be used without generic arguments, in which case it is equivalent to collections.abc.Callable.
2016-11-02 21:43:33 +02:00
Takeshi KOMIYA
b32d9a9bc7
Merge pull request #3071 from mleinart/autodoc/pass_through_decorators
...
Autodoc: Allow mocked module decorators to pass-through functions unchanged
2016-11-02 23:01:16 +09:00
shimizukawa
a5bdf1fdae
Closes #3060 : autodoc supports documentation for attributes of Enum class. Now autodoc render just the value of Enum attributes instead of Enum attribute representation.
2016-10-28 00:02:09 +09:00
Michael Leinartas
7943da9408
Add tests for mocked modules
2016-10-21 09:53:25 -05:00
shimizukawa
021974ed94
refs #2432 update for latest master
2016-10-19 01:08:07 +09:00
Takayuki SHIMIZUKAWA
340c6fb9f4
Merge pull request #2432 from agronholm/kwonlyargs
...
#2432 Fix unwanted * between varargs and keyword only args
2016-10-19 00:54:38 +09:00
Joost van Zwieten
099b58f7fe
ext.autodoc: fix formatting instance annotations
...
Currently `format_annotation` fails on instances, because instances don't have
`__module__` and `__qualname__` attributes. Defer building the
`qualified_name` of an annotation until we have established that the annotation
is a type.
2016-08-07 16:18:22 +02:00
Takeshi KOMIYA
80921b2ab8
Fix flake8 violation under tests/
2016-06-12 00:02:11 +09:00
