Álvaro Mondéjar
02d5cd439f
Update 'test_autosummary_generate' test.
2020-05-14 19:16:45 +02:00
Álvaro Mondéjar
1dcfc44ace
Fix automsummary directive wrong processing for invalid modules.
2020-05-14 17:06:12 +02:00
Takeshi KOMIYA
c4d4ba2835
Fix #7551 : autosummary: a nested class is indexed as non-nested class
2020-05-07 01:57:46 +09:00
Takeshi KOMIYA
5bf997c55a
refactor: Do not pass deprecated parameter in testcase
2020-05-03 23:41:54 +09:00
Takeshi KOMIYA
0bf9011509
Fix #7570 : autosummary: template option is broken
2020-04-30 00:14:59 +09:00
Takeshi KOMIYA
037fe96dc1
Close #4030 : autosummary: Add autosummary_context
2020-04-25 11:15:43 +09:00
Takeshi KOMIYA
ab3795f176
Fix #7536 : sphinx-autogen: crashes when template uses i18n feature
2020-04-23 21:46:32 +09:00
Takeshi KOMIYA
72c57ff131
test: Fix flake8 violation
2020-04-22 01:29:48 +09:00
Takeshi KOMIYA
4a7934ba1a
autosummary: Make recursively generated stub-files flatten
2020-04-22 00:27:59 +09:00
Takeshi KOMIYA
cc6ba63f5e
test: Remove meaningless testcases
2020-04-22 00:23:37 +09:00
Takeshi KOMIYA
ef1362886f
refactor: Not to use deprecated helper: Path.text()
2020-04-21 23:39:51 +09:00
Takeshi KOMIYA
7671bcc23b
Remove autosummary_recursive configuration
...
Now autosummary directive has :recursive: option to enable the
recursive feature individually. So the configuration is no longer
needed.
2020-04-21 23:38:18 +09:00
Takeshi KOMIYA
b9da9237bc
Merge branch '3.x' into 6040_autosummary_recursive
2020-04-21 23:04:38 +09:00
Takeshi KOMIYA
476b73b6ca
autosummary: Add :recursive: option to autosummary directive
2020-04-21 22:47:00 +09:00
Takeshi KOMIYA
dc46897768
Close #7490 : autosummary: Add `:caption:` option to autosummary directive
2020-04-16 23:04:57 +09:00
Takeshi KOMIYA
4352991338
refactor: autosummary: Define AutosummaryEntry as a return type of find_autosummary_*()
2020-03-16 10:41:37 +09:00
Takeshi KOMIYA
665458561f
fix
2020-02-23 01:41:31 +09:00
Takeshi KOMIYA
bdd08b1516
test: encoding="utf-8" is no longer needed on reading text
2020-02-01 12:25:49 +09:00
Takeshi KOMIYA
4dd8b1022f
test: Use read_text() and read_bytes()
2020-02-01 11:58:51 +09:00
Takeshi KOMIYA
0319faf8f1
Merge branch '2.0'
2020-01-01 14:40:39 +09:00
Takeshi KOMIYA
eaf495c3c4
A happy new year!
2020-01-01 14:27:43 +09:00
Takeshi KOMIYA
15c266c445
Merge branch '2.0'
2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
491b19d6bb
autosummary: Allows to document a member forcedly if skip-member handler returns False
2019-11-16 18:19:33 +09:00
Takeshi KOMIYA
66c3dd3adb
Close #6798 : autosummary: emit `autodoc-skip-member` event on generating stub file
2019-11-16 18:19:31 +09:00
woutdenolf
11d9a97a34
refactor autosummary recursion tests
2019-07-08 09:06:52 +02:00
woutdenolf
9dc9b8754d
Merge with master and address code review
2019-07-08 08:29:23 +02:00
Takeshi KOMIYA
4af90fcf75
Fix #247 : autosummary: Add autosummary_generate_option to overwrite old stub file
2019-07-07 16:18:49 +09:00
Takeshi KOMIYA
95723aa6f6
Fix flake8 violations
2019-07-01 00:28:30 +09:00
Takeshi KOMIYA
8017b6ec2c
Fix flake8 violations
2019-06-30 14:55:22 +09:00
Takeshi KOMIYA
e7644547e7
Merge branch '2.0' into refactor_autosummary3
2019-06-22 01:34:47 +09:00
Takeshi KOMIYA
1aa1373ce3
Fix #6498 : autosummary: crashed with wrong autosummary_generate setting
2019-06-19 14:03:42 +09:00
Takeshi KOMIYA
ab38b2dd8e
Fix #6507 : autosummary: crashes without no autosummary_generate setting
2019-06-19 13:51:38 +09:00
Takeshi KOMIYA
bc5e18af92
Fix #6452 : autosummary: crashed when generating document of properties
2019-06-07 02:23:39 +09:00
woutdenolf
ec8656bd27
[autosummary] remove recursion limit and module/package separation
2019-06-02 16:26:40 +02:00
woutdenolf
140ae00baa
Merge branch 'master' into feature-autosummary-packages
2019-06-01 12:42:28 +02:00
Takeshi KOMIYA
dd1b5beb74
Fix #6350 : autosummary is confused by an argument having namedtuple as a default value
2019-05-25 21:25:07 +09:00
Takeshi KOMIYA
5d640f3c10
Fix #6350 : autosummary is confused by an argument having default string value containing a single quote
2019-05-25 21:25:07 +09:00
woutdenolf
1a67b87910
Merge branch 'master' into feature-autosummary-packages
2019-05-18 14:42:34 +02:00
Takeshi KOMIYA
d290dfd7e9
Fix #6311 : autosummary: autosummary table gets confused by complex type hints
2019-05-12 14:53:25 +09:00
woutdenolf
6e0b0517c0
[autosummary] address code review
2019-04-07 12:00:57 +02:00
woutdenolf
4004dd5635
Merge branch 'master' into feature-autosummary-packages
2019-04-07 10:32:57 +02:00
tsanikgr
bec116a3b6
#5877 : Allow setting imported_members for autosummary in conf.py
2019-03-27 14:19:16 +00:00
Takeshi KOMIYA
65970a3033
Fix #6140 : Use unittest.mock instead of mock
2019-03-09 15:16:04 +09:00
Takeshi KOMIYA
c83f2a0272
Fix #6140 : Use unittest.mock instead of mock
2019-03-08 00:27:45 +09:00
woutdenolf
33e7b76c32
Merge branch 'master' into feature-autosummary-packages
2019-02-24 12:16:52 +01:00
woutdenolf
2a7d6081d9
[autosummary] test package recursion
2019-02-24 12:13:04 +01:00
Takeshi KOMIYA
73b8d6ff33
Closes #5636 : autosummary: Add autosummary_mock_imports to mock external libraries
2019-02-11 23:19:25 +09:00
woutdenolf
4365c8436f
[autosummary] tests for autosummary modules and packages
2019-02-08 16:11:29 +01:00
Takeshi KOMIYA
25027945f5
Close #4550 : All tables and figures without `align` option are displayed to center
2019-02-08 01:39:41 +09:00
Takeshi KOMIYA
68c90a26f1
quickstart: Simplify generated conf.py (for latex)
2019-01-07 23:06:14 +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
fd1dd13a50
refactor: Replace six.StringIO by io.StringIO
2018-12-15 21:00:38 +09:00
Jon Dufresne
0d6be504ea
Remove use of six.iteritems()
...
In Python 3, dict.items() is always an iterator.
2018-09-11 06:03:34 -07:00
Takeshi KOMIYA
922e218214
Fix #5158 : autosummary: module summary has been broken when it starts with heading
2018-07-16 18:45:28 +09:00
Takeshi KOMIYA
a2f6de88c1
Fix #5146 : autosummary: warning is emitted when the first line of docstring ends with literal notation
2018-07-08 21:14:01 +09:00
jfbu
c59a0ccae1
Fix autosummary latex table colspec ( closes #4790 )
2018-03-28 10:03:18 +02:00
Takeshi KOMIYA
fdefe987d5
Fix #4689 : autosummary: unexpectedly strips docstrings containing "i.e."
2018-03-04 02:12:13 +09:00
Takeshi KOMIYA
c435bcf8dc
Fix #4685 : autosummary emits meaningless warnings
2018-03-01 22:29:50 +09:00
Takeshi KOMIYA
d40db5efa2
Fix #4563 : autosummary: Incorrect end of line punctuation detection
2018-02-19 14:42:19 +09:00
Takeshi KOMIYA
20613edc03
refactor: Add extract_summary() for easily testing
2018-02-19 14:40:39 +09:00
Takeshi KOMIYA
18c0b23797
Merge branch 'stable' into 1.7-release
2018-02-04 23:20:48 +09:00
Takeshi KOMIYA
929379d0ce
Fix #2372 : autosummary: invalid signatures are shown for type annotated functions
2018-02-03 16:53:26 +09:00
Takeshi KOMIYA
2994014cf9
Merge pull request #4247 from jorisvandenbossche/autosummary-attributes
...
BUG: autosummary to list all class members
2018-01-30 10:44:18 +09:00
Takeshi KOMIYA
fb921c7457
Merge branch 'master' into refactor_autodoc
2018-01-08 15:10:43 +09:00
Joel Nothman
db415ba05c
Avoid duplicate calls to autodoc-process-docstring ( #4198 )
2018-01-08 11:09:29 +09:00
Takeshi KOMIYA
e1d8615ce4
Don't use add_documenter() in sphinx-autogen
2018-01-07 00:05:48 +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
Joris Van den Bossche
098add17f6
BUG: autosummary to list all class members
2017-11-17 09:45:01 +01:00
Pauli Virtanen
189e25ac0e
Fix issue in import_module returning wrong module
2017-11-11 18:00:03 +01:00
Takeshi KOMIYA
dc6a8a5457
test: Fix autosummary testcase
2017-07-02 18:41:03 +09:00
Takeshi KOMIYA
b3e0e29f4c
Fix #3900 : autosummary could not find methods
2017-07-02 18:26:41 +09:00
shimizukawa
d497d74370
refs #3458 : add sphinx.testing that are moved from /tests directory.
2017-05-14 20:47:15 +09:00
Takeshi KOMIYA
56d3458584
Fix flake8 violations
2017-05-09 21:57:36 +09:00
Takeshi KOMIYA
592b808005
Merge pull request #3585 from eric-wieser/escape-autosummary
...
BUG: Fix autosummary of members with a trailing underscore
2017-03-29 22:56:32 +09:00
Eric Wieser
804891c4a1
BUG: Fix autosummary of members with a trailing underscore
2017-03-26 12:54:03 +01:00
Takeshi KOMIYA
c57e47e042
Year++
2017-03-26 11:49:34 +09:00
Takeshi KOMIYA
bfcb92f6fd
Fix #3285 : autosummary: asterisks are escaped twice
2017-01-21 15:50:41 +09:00
shimizukawa
baaef9146d
pytest: remove deprecated with_app decorator functions
2017-01-06 01:14:47 +09:00
Takeshi KOMIYA
13c63cb173
Optimize tests: test_get_items_summary
2016-07-14 21:07:33 +09:00
Georg Brandl
46d7e8558e
Obligatory copyright update.
2016-01-14 22:54:04 +01:00
Georg Brandl
a23903d8d5
Merge branch 'stable'
2015-01-03 21:41:14 +01:00
Georg Brandl
d47a7587f9
Complete test suite overhaul.
...
* rename a few test modules to make the names more consistent
* do not copy/use Sphinx from build/ (unnecessary without 2to3)
* use a temporary dir for *all* test projects, the source tree
will stay pristine that way (default is tests/build)
* speed up tests by ~3x by splitting up test projects and avoiding
rebuilds
2014-09-21 17:17:02 +02:00
