Commit Graph

2722 Commits

Author SHA1 Message Date
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
1148f9f951 Merge branch '2.1.1' into 6451_autodoc_optonal_imported_modules 2019-06-10 02:31:32 +09:00
Takeshi KOMIYA
bc61713ab6 Merge branch '2.1.1' into 6436_napoleon_unknown_target_name 2019-06-10 01:00:39 +09:00
Takeshi KOMIYA
c4dfc7402e Fix #6436: napoleon: "Unknown target name" error 2019-06-09 00:23:18 +09:00
Takeshi KOMIYA
0aed08b5be Fix #6451: autodoc: generates docs for "optional import"ed modules as variables 2019-06-08 19:06:52 +09:00
Stephen Finucane
65122ad1cb apidoc: Insert newlines between submodules
Fix a regression introduced in 2.1.0 where submodules didn't have a
newline between them resulting in the following warning:

  Explicit markup ends without a blank line; unexpected unindent.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #6440
2019-06-07 15:35:01 +01:00
Takeshi KOMIYA
bc5e18af92 Fix #6452: autosummary: crashed when generating document of properties 2019-06-07 02:23:39 +09:00
Takeshi KOMIYA
27dd8367c6 Merge pull request #6423 from tk0miya/1063_autodoc_undoc_module_variables
Fix #1063: autodoc: automodule directive handles undocumented module level variables
2019-06-02 16:20:49 +09:00
Takeshi KOMIYA
91fceb4b5f Merge branch '2.0.2' into 2.0 2019-06-02 00:58:46 +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
e001d358d0 Add :force: option to code directives 2019-06-01 13:42:57 +09:00
Takeshi KOMIYA
2afba22cee Merge pull request #6397 from tk0miya/6361_autodoc_typehints
Close #6361: autodoc: Add autodoc_typehints to suppress typehints from signature
2019-06-01 01:07:37 +09:00
Takeshi KOMIYA
b4923fc23d Merge pull request #6412 from tk0miya/refactor_apidoc
refactor apidoc: Add is_skipped_module()
2019-05-31 01:34:51 +09:00
Takeshi KOMIYA
be6f4fd8f6 refactor apidoc: Add is_skipped_module() 2019-05-30 01:12:23 +09:00
Takeshi KOMIYA
e80f88ac62 Merge pull request #6404 from tk0miya/6347_autodoc_crashes_by_plain_Tuple
Fix #6347: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5
2019-05-30 00:58:45 +09:00
Takeshi KOMIYA
4ded940ee5 Close #6239: latex: Support to build Chinese documents 2019-05-29 00:58:11 +09:00
Takeshi KOMIYA
880c47ff61 Fix #6347: autodoc: crashes with a plain Tuple on Python 3.6 and 3.5 2019-05-29 00:51:01 +09:00
Takeshi KOMIYA
224551ca6c Merge pull request #6395 from tk0miya/6350_autosummary_is_confused_by_default_value
Fix #6350: autosummary is confused by an argument having some kind of default value
2019-05-27 01:53:34 +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
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
Stefan Wallentowitz
ac0bb5132b Fix latex figure in admonition
Using figures in an admonition produces a LaTeX error ("Not in outer
par mode."). This is because it generates a float in a float. This can
be trivially fixed by overwriting the alignment to H, which is also
what is most probably intended.
2019-05-24 16:07:13 +02:00
Takeshi KOMIYA
277aba935d Close #6325: autodoc: Support attributes in __slots__ 2019-05-22 09:56:46 +09:00
Takeshi KOMIYA
557d8d140e Merge pull request #6365 from tk0miya/refactor_py_domain
Add :abstractmethod: option to py:method directive and support abstractmethod by autodoc
2019-05-19 23:46:34 +09:00
Takeshi KOMIYA
603bae4173 Merge pull request #6376 from tk0miya/6375_angle_brackets_in_linktitle
Fix #6375: extlinks: Cannot escape angle brackets in link caption
2019-05-19 23:43:50 +09:00
Takeshi KOMIYA
1be3f6c653 Merge branch '2.0' into 6375_angle_brackets_in_linktitle 2019-05-19 23:28:05 +09:00
Takeshi KOMIYA
8ed6a9ceb4 Fix #6379: py domain: Module index (py-modindex.html) has duplicate titles 2019-05-19 22:19:13 +09:00
Takeshi KOMIYA
092d87bde9 Fix #6375: extlinks: Cannot escape angle brackets in link caption 2019-05-16 23:14:57 +09:00
Adrián Chaves
e84ba7f78a Support coverage_ignore_pyobjects in the coverage builder 2019-05-15 12:23:05 +02:00
Takeshi KOMIYA
e288999933 Close #744: autodoc: Support abstractmethod 2019-05-15 00:01:00 +09:00
Takeshi KOMIYA
358e582490 Add :abstractmethod: option to py:method directive (refs: #6138) 2019-05-15 00:00:51 +09:00
Takeshi KOMIYA
59d0f076ec Merge branch '2.0' into 6311_autosummary_confused_by_complex_typehints2 2019-05-13 21:16:43 +09:00
Takeshi KOMIYA
ca605c7437 Add :type: option for rst:directive:option directive 2019-05-13 14:14:14 +09:00
Takeshi KOMIYA
4307dec3ac Add rst:directive:option directive 2019-05-13 13:55:56 +09:00
Takeshi KOMIYA
19a006f620 Merge branch '2.0' into refactor_py_domain3 2019-05-12 18:29:05 +09:00
Takeshi KOMIYA
935d1ad0af Merge pull request #6201 from tk0miya/6165_tab_width
Fix #6165: autodoc: ``tab_width`` setting of docutils has been ignored
2019-05-12 17:19:55 +09:00
Omer Katz
e08e7b05d3 Add a label to search input for accessability purposes. 2019-05-12 17:09:18 +09:00
Takeshi KOMIYA
1e0a377279 Merge branch '2.0' into 6165_tab_width 2019-05-12 17:06:49 +09:00
Takeshi KOMIYA
b708f7b82f autodoc: Add PropertyDocumenter to detect properties 2019-05-12 15:59:57 +09:00
Takeshi KOMIYA
c59f2d9545 Add sphinx.util.inspect:isproperty() 2019-05-12 15:53:39 +09:00
Takeshi KOMIYA
a142a654fc Add :property: option to py:method directive 2019-05-12 15:53:39 +09:00
Takeshi KOMIYA
d290dfd7e9 Fix #6311: autosummary: autosummary table gets confused by complex type hints 2019-05-12 14:53:25 +09:00
Takeshi KOMIYA
c27373ad76 Merge pull request #6341 from tk0miya/4550_centering_tables_using_css
Fix #4550: html: Centering tables by default using CSS
2019-05-12 13:33:37 +09:00
Takeshi KOMIYA
dc1c5fee70 Fix #6331: man: invalid output when doctest follows rubric 2019-05-06 21:27:43 +09:00
Takeshi KOMIYA
a9b3ec5322 Merge pull request #6338 from tk0miya/template_for_apidoc
refactor apidoc: Add templates for generating reST files
2019-05-06 21:08:30 +09:00
Takeshi KOMIYA
8c37f1f482 Merge test_ext_inheritance.py to test_ext_inheritance_diagram.py 2019-05-06 20:22:06 +09:00
Takeshi KOMIYA
107c20a11f Fix #4550: html: Centering tables by default using CSS 2019-05-06 20:19:53 +09:00
Takeshi KOMIYA
b93f53c7e4 apidoc: Use a template for generating package file 2019-05-04 18:42:22 +09:00
Takeshi KOMIYA
e41d6f3651 apidoc: Use a template for generating toc file 2019-05-04 17:19:31 +09:00
Takeshi KOMIYA
b482e38ca2 apidoc: Use a template for generating module file 2019-05-04 17:19:31 +09:00