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
Alex Grönholm
0beabaf4cf
Fix unwanted * between varargs and keyword only args
...
The * parameter must only be present when a holder for positional variable arguments is not present.
2016-04-09 17:35:32 +03:00
Takeshi KOMIYA
dca1669b2f
Merge pull request #2300 from akruis/feature_autoclass_content_from__new__
...
Feature: enhance autoclass:: to use the docstring of __new__ if __init__ method's is missing of empty
2016-02-14 14:45:25 +09:00
Anselm Kruis
0311f33347
Feature: enhance autoclass:: to use the docstring of __new__
...
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.
2016-02-05 19:09:43 +01:00
Georg Brandl
4f72bdb722
Merge branch 'stable'
2016-01-14 22:54:08 +01:00
Georg Brandl
46d7e8558e
Obligatory copyright update.
2016-01-14 22:54:04 +01:00
Alberto Berti
782310039b
Move py3.5 specific tests to their own file and adjust test environment
2015-11-10 03:40:48 +01:00
Alberto Berti
933ed5a50c
Add a test for doc on coroutine functions and general support for async/await py3.5 syntax
2015-11-10 02:38:17 +01:00
Andrey Vlasovskikh
ef0d4e7946
Skip type hinting tests if there is a SyntaxError while importing a module with function annotations
2015-07-31 21:56:13 +03:00
Andrey Vlasovskikh
1224256341
Use 'SkipTest' from 'util' for tests
2015-07-31 21:54:01 +03:00
Andrey Vlasovskikh
dd32b7fdb2
Closes #1968 : Show extended type hints for function annotations that use 'typing' module
2015-07-31 21:26:32 +03:00
Erik M. Bray
def08a206f
Fix documentation of descriptor classes that have a custom metaclass
...
(i.e. a subclass of type). This avoids using string comparisons to do
type checks, except in the case of the fix for #1155 , since in Python 3
there really seems to be no way to export the instancemethod type, short
of using ctypes.
2015-04-09 19:09:24 -04:00
Georg Brandl
a23903d8d5
Merge branch 'stable'
2015-01-03 21:41:14 +01:00
Georg Brandl
567d52f199
all: update copyright
2015-01-03 21:36:32 +01:00
Georg Brandl
4f4d8688d5
Py3 fix.
2014-11-07 15:19:36 +01:00
