Commit Graph
217 Commits
Author SHA1 Message Date
Takeshi KOMIYA e0eb86224d Merge branch '2.1.1' into 2.0 2019-06-10 22:31:18 +09:00
Takeshi KOMIYA 21be789d4d Revert "Fix #1063: autodoc: automodule directive handles undocumented module level variables"
This reverts commit 69d93c967c (without
CHANGES).
2019-06-10 21:40:11 +09:00
Takeshi KOMIYA 81e2e1d971 test: Update testcase for autoclass_content and autodoc_docstring_signature 2019-06-03 23:20:33 +09:00
Takeshi KOMIYA f7851b62e0 test: Update testcase for autoclass_content 2019-06-03 23:20:33 +09:00
Takeshi KOMIYA f4114bb794 test: Update testcase for autodoc_inherit_docstrings 2019-06-03 22:34:35 +09:00
Takeshi KOMIYA 42e9fd896e test: Move class inheritance samples into target.inheritance module 2019-06-03 22:34:33 +09:00
Takeshi KOMIYA c8554e7673 test: Move testcases for autodoc events to test_ext_autodoc_events 2019-06-03 01:32:36 +09:00
Takeshi KOMIYA 7de8c63407 test: Move testcases for autodoc configurations to test_ext_autodoc_configs 2019-06-03 01:28:56 +09:00
Takeshi KOMIYA 8da90bbe24 test: Update testcase for autodoc-process-docstring 2019-06-03 01:16:20 +09:00
Takeshi KOMIYA e274ae87a5 test: Update testcase for cut_lines() 2019-06-03 01:16:20 +09:00
Takeshi KOMIYA 3f617a4a9b test: Update testcase for between() 2019-06-03 01:16:20 +09:00
Takeshi KOMIYA 6cbee7de3c test: Move descriptor example to independent file 2019-06-03 00:38:01 +09:00
Takeshi KOMIYA afbf6d811d Migrate to py3 style type annotation: sphinx.util 2019-06-02 17:51:20 +09:00
Takeshi KOMIYA 69d93c967c Fix #1063: autodoc: automodule directive handles undocumented module level variables 2019-06-01 23:18:37 +09:00
Takeshi KOMIYA 0ea380eddd Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature 2019-05-26 00:35:24 +09:00
Takeshi KOMIYA 277aba935d Close #6325: autodoc: Support attributes in __slots__ 2019-05-22 09:56:46 +09:00
Takeshi KOMIYA e288999933 Close #744: autodoc: Support abstractmethod 2019-05-15 00:01:00 +09:00
Takeshi KOMIYA 19a006f620 Merge branch '2.0' into refactor_py_domain3 2019-05-12 18:29:05 +09:00
Takeshi KOMIYA b708f7b82f autodoc: Add PropertyDocumenter to detect properties 2019-05-12 15:59:57 +09:00
Takeshi KOMIYA 1ea23e14df Fix #6165: autodoc: `tab_width` setting of docutils has been ignored 2019-04-25 21:44:44 +09:00
Takeshi KOMIYA 435ef05b99 Close #4777: autodoc: Support coroutine 2019-04-23 01:55:48 +09:00
Takeshi KOMIYA a285220778 Merge branch '2.0' into refactor_py_domain2 2019-04-23 01:16:42 +09:00
Takeshi KOMIYA cc7a81419f Merge pull request #6289 from alsrgv/add_imported_members_directive
Add imported-members to the directive whitelist
2019-04-15 10:24:08 +09:00
Alex Sergeev b7f6657dd1 Address feedback 2019-04-13 22:09:01 -10:00
Alex Sergeev 15daf84f1a Add support for bound methods posing as functions in the module 2019-04-13 20:57:24 -10:00
Alex Sergeev 4bad5bd419 Address feedback 2019-04-13 20:54:20 -10:00
Takeshi KOMIYA aca8122d04 autodoc: Use new options for py:method directive 2019-04-13 23:50:07 +09:00
Takeshi KOMIYA 446bee8c66 refactor: test_autodoc 2019-02-27 15:08:44 +09:00
Takeshi KOMIYA 8a391d1781 Merge branch '1.8' 2019-02-17 22:37:23 +09:00
Takeshi KOMIYA 08cd23a0bb Fix #6047: autodoc: `autofunction` emits a warning for method objects 2019-02-17 18:23:14 +09:00
Takeshi KOMIYA 686486498c Closes #1148: autodoc: Add autodecorator directive for decorators 2019-02-15 02:14:38 +09:00
Takeshi KOMIYA ad517af81c Merge branch 'master' into 5459_autodoc_default_options_accepts_True 2019-02-11 12:34:59 +09:00
Takeshi KOMIYA b0148c6921 Closes #5459: autodoc: autodoc_default_options accepts True as a value 2019-02-11 02:03:09 +09:00
Takeshi KOMIYA a6ef8190ce Add testcase for mocked objects in autodoc 2019-02-11 01:46:38 +09:00
Takeshi KOMIYA 76e9f57c2e Merge branch '1.8' 2019-01-02 16:16:25 +09:00
Takeshi KOMIYA 1b1ebd2c75 A happy new year! 2019-01-02 16:00:30 +09:00
Jon Dufresne bade33c7e4 Remove unnecessary encoding cookie from Python source files
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
2018-12-16 12:22:12 -08:00
Takeshi KOMIYA c6bd84a614 refactor: Remove u-prefix from strings 2018-12-16 21:28:51 +09:00
Takeshi KOMIYA 66fad4e22d Remove a hack for py2 from testcode 2018-12-15 22:01:22 +09:00
Takeshi KOMIYA 4761e70c37 Merge branch '1.8' 2018-11-22 22:14:32 +09:00
Jon Dufresne 555960d668 Deprecate and drop internal use of force_decode()
In the Python 3 only code base, this function is no longer necessary.
The type of values is well understood and deliberate. Code should avoid
arbitrary mixing of bytes & str.

By removing force_decode() calls from docstring values, can deprecate
the now unused 'encoding' arguments to various autodoc methods.
2018-11-13 07:16:39 -08:00
Takeshi KOMIYA 0ccc64d9ea test: Filter warnings on testing 2018-11-12 00:37:51 +09:00
Takeshi KOMIYA 9c4e5b244a test: Replace call_autodoc() by do_autodoc() 2018-11-11 21:22:11 +09:00
Takeshi KOMIYA ea03286647 test: Move autodoc_missing_imports to test-ext-autodoc 2018-10-17 11:36:11 +09:00
Eric N. Vander Weele d6b9db9581 tests: Ensure 'member-only' autodoc_default_options is respected
When specifying the 'member-only' option to `autodoc_default_options`,
ensure it is respected.
2018-10-14 20:18:59 -04:00
Takeshi KOMIYA dc44b0d2a9 Merge branch 'master' into HEAD 2018-09-22 22:54:15 +09:00
Takeshi KOMIYA 3a2418a827 refactoring: Drop PY2 and PY3 flags 2018-09-22 21:27:59 +09:00
Takeshi KOMIYA 48c634e623 test: Merge py35/test_autodoc_py35.py to test_autodoc.py 2018-09-22 16:41:44 +09:00
Takeshi KOMIYA b18fe13f55 Drop branches for sys.version_info < (3, 4) 2018-09-22 16:31:07 +09:00
Takeshi KOMIYA 522105b79b Merge branch '1.8' 2018-09-20 20:01:14 +09:00