Commit Graph

13205 Commits

Author SHA1 Message Date
Takeshi KOMIYA
224d247ca0 Fix mypy violations (for mypy-0.710) 2019-06-21 11:07:27 +09:00
Takeshi KOMIYA
6595f65b0e Bump version 2019-06-19 20:34:10 +09:00
Takeshi KOMIYA
39563d1b29 Bump to 2.1.2 final 2019-06-19 20:31:54 +09:00
Jon Dufresne
131c93caf5 Remove "universal" configuration from setup.cfg
Sphinx is Python-3-only and therefore is not a universal wheel. It
should still distribute a 'py3' wheel, just not a universal one.

From https://wheel.readthedocs.io/en/stable/user_guide.html

> If your project contains no C extensions and is expected to work on
> both Python 2 and 3, you will want to tell wheel to produce universal
> wheels by adding this to your setup.cfg file: …

As Sphinx doesn't work on Python 2, it should not be universal.

Refs #6470
2019-06-19 20:31:54 +09:00
Takeshi KOMIYA
2709cd3cd1 Update CHANGES for PR #6482 2019-06-19 20:30:03 +09:00
Takeshi KOMIYA
982f63e4a2
Merge pull request #6482 from ViktorHaag/object-descr-setting-class-type-map-iss6478
Explicitly treat ObjectDescription._doc_field_type_map as an instance variable
2019-06-18 23:04:42 +09:00
Viktor Haag
e9ee39d655 repair white space 2019-06-18 09:37:52 -04:00
Viktor Haag
6a054355d9 Simplify to ensure we're lazily setting the instance field-type-map variable
- We can more simply have ObjectDescription.get_field_type_map() make sure that
  it's going to lazily set the value of an instance variable, not the class
  variable, when it populates the field type map.
2019-06-18 09:22:25 -04:00
Takeshi KOMIYA
be0856190f
Merge pull request #6502 from tk0miya/6497_custom_lexers_fails_highlighting
Fix #6497: custom lexers fails highlighting when syntax error
2019-06-18 21:36:36 +09:00
Takeshi KOMIYA
2119a65b86 Fix #6497: custom lexers fails highlighting when syntax error 2019-06-18 01:43:14 +09:00
Viktor Haag
d19dd1c8de mypy type annotations for methods added
- type annotation for _process_type_map was incorrect; needed to document the
  positional argument for the method

- __init__ method for ObjectDescription missing type annotation, so added
2019-06-14 08:02:24 -04:00
Viktor Haag
085ae2e081 type declaration for new internal method 2019-06-13 14:29:21 -04:00
Viktor Haag
3973e897d1 Explicitly treat ObjectDescription._doc_field_type_map as an instance variable
- Aims to address [issue #6478](https://github.com/sphinx-doc/sphinx/issues/6478)

- Left ObjectDescription._doc_field_type_map declaration alone and in place in
  case there are other factors at play that require it declared on the class.

- In ObjectDescription constructor, explicitly set _doc_field_type_map's value
  as an instance variable.

- This presumably needs to be built with every instantiation of an
  ObjectDescription or inheriting class, so we're not attempting to "define it
  once on a class and then use it"... that approach seems much harder to reason
  about and get correctly done (as was maybe demonstrated by the refactoring
  that lead to this problem in the linked-to issue).

- Runs through the test suite clean locally except for an unrelated single test
  failure on an image_converter test, which also failed on the base branch
  before my changes here.
2019-06-13 14:01:57 -04:00
Takeshi KOMIYA
5b307fcf4f Bump version 2019-06-10 22:36:32 +09:00
Takeshi KOMIYA
afa4a772da Bump to 2.1.1 final 2019-06-10 22:34:45 +09:00
Takeshi KOMIYA
1eb8e0145c
Merge pull request #6471 from tk0miya/6447_revert_undoc_module_level_variables
Revert "Fix #1063: autodoc: automodule directive handles undocumented module level variables"
2019-06-10 22:25:21 +09:00
Takeshi KOMIYA
8828017f6c Update CHANGES 2019-06-10 21:42:51 +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
2289ae0a11
Merge pull request #6458 from tk0miya/6451_autodoc_optonal_imported_modules
Fix #6451: autodoc: generates docs for "optional import"ed modules as variables
2019-06-10 02:49:14 +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
c3b93c15c2 Update CHANGES for PR #6445 2019-06-10 01:42:14 +09:00
Takeshi KOMIYA
0b95f3f6b3
Merge pull request #6460 from tk0miya/6436_napoleon_unknown_target_name
Fix #6436: napoleon: "Unknown target name" error
2019-06-10 01:09:42 +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
783de00bf0
Merge pull request #6457 from tk0miya/6455_napoleon_ignores_properties
Fix #6455: napoleon: docstrings for properties are not processed
2019-06-10 00:43:12 +09:00
Takeshi KOMIYA
dc540e2c78
Merge pull request #6465 from bingyao/6464_fix_language_code_links
Fix #6464: Update invalid links for language codes references
2019-06-10 00:42:05 +09:00
Bingyao Liu
34acdc37aa Fix #6464: updated invalid links of language codes in quickstart and all locale po files 2019-06-09 21:47:43 +08:00
Bingyao Liu
ec2ee2f7a0 docs: Update invalid file path of configuration.rst in devguide 2019-06-09 21:45:40 +08:00
Takeshi KOMIYA
c4dfc7402e Fix #6436: napoleon: "Unknown target name" error 2019-06-09 00:23:18 +09:00
Stephen Finucane
5ec9c4bc9a
Merge pull request #6445 from stephenfin/issue/6440
apidoc: Insert newlines between submodules
2019-06-08 14:02:35 +01:00
Takeshi KOMIYA
0aed08b5be Fix #6451: autodoc: generates docs for "optional import"ed modules as variables 2019-06-08 19:06:52 +09:00
Takeshi KOMIYA
4945628594 Fix #6455: napoleon: docstrings for properties are not processed 2019-06-08 13:51:14 +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
f0b1cbb734
Merge pull request #6453 from tk0miya/6452_autosummary_crashed_with_properties
Fix #6452: autosummary: crashed when generating document of properties
2019-06-07 22:49:01 +09:00
Takeshi KOMIYA
bc5e18af92 Fix #6452: autosummary: crashed when generating document of properties 2019-06-07 02:23:39 +09:00
Jean-François B
80a34a4b98
Merge pull request #6443 from jfbu/latex_note_fixallowbreak
LaTeX: prevent pagebrak separating note from section title
2019-06-05 17:10:37 +02:00
jfbu
40678562df Merge branch '2.1.1' into latex_note_fixallowbreak 2019-06-05 17:09:56 +02:00
Takeshi KOMIYA
2f93300920 Fix #6448: autodoc: crashed when autodocumenting classes with __slots__ = None 2019-06-05 22:28:39 +09:00
Audrey Dutcher
e3321bb3a9 Don't crash when autodocumenting classes with __slots__ = None 2019-06-05 22:27:54 +09:00
jfbu
bf0ad9e80c LaTeX: prevent pagebrak separating note from section title
Fixes: #6442
2019-06-04 13:57:24 +02:00
Takeshi KOMIYA
3360f2461c Bump version 2019-06-02 21:14:52 +09:00
Takeshi KOMIYA
653b0e0000 Bump to 2.1.0 final 2019-06-02 21:10:40 +09:00
Takeshi KOMIYA
290ead8ce7 Merge changes entry for 2.0.2 to 2.1.0 2019-06-02 20:33:42 +09:00
Takeshi KOMIYA
84da50cd88
Merge pull request #6428 from tk0miya/improve_docs
docs: Use directive:option in extensions/graphviz
2019-06-02 18:39:04 +09:00
Takeshi KOMIYA
1303ea7cdf docs: Use directive:option in extensions/graphviz 2019-06-02 18:18:55 +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
54d5fcfaeb
Merge pull request #6416 from tk0miya/2310_force_highlighting
Add :force: option to code directives
2019-06-01 14:17:53 +09:00
Takeshi KOMIYA
71842264b2 Sphinx.add_lexer() now takes a Lexer class instead of instance 2019-06-01 13:49:16 +09:00
Takeshi KOMIYA
5d8c25b605 refactor: app.add_lexer() 2019-06-01 13:42:57 +09:00