IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
13,392 Commits 2 Branches 219 Tags 163 MiB
eb07a0fee1
Commit Graph

13392 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
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
Jon Dufresne
8d93da09ba 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-13 08:07:54 -07:00
Takeshi KOMIYA
828c4a44f5
Merge pull request #6468 from tk0miya/refactor_autosummary 
autosummary: deprecate info and warn arguments for generate_autosummary_docs()
 2019-06-13 23:49:02 +09:00
Takeshi KOMIYA
7609e67d19 Migrate to py3 style type annotation: sphinx.builders.epub3 2019-06-10 23:17:51 +09:00
Takeshi KOMIYA
1d371c2ceb Migrate to py3 style type annotation: sphinx.builders._epub_base 2019-06-10 23:17:51 +09:00
Takeshi KOMIYA
4488815dca Migrate to py3 style type annotation: sphinx.builders.dummy 2019-06-10 23:17:51 +09:00
Takeshi KOMIYA
7f2e9cebf9 Migrate to py3 style type annotation: sphinx.builders.singlehtml 2019-06-10 23:17:51 +09:00
Takeshi KOMIYA
13bd831110 Migrate to py3 style type annotation: sphinx.builders.dirhtml 2019-06-10 23:17:51 +09:00
Takeshi KOMIYA
5716aa7a74 Migrate to py3 style type annotation: sphinx.builders.devhelp 2019-06-10 23:17:51 +09:00
Takeshi KOMIYA
9a085794a2 Migrate to py3 style type annotation: sphinx.builders.linkcheck 2019-06-10 23:17:51 +09:00
Takeshi KOMIYA
dd5f968bfa Migrate to py3 style type annotation: sphinx.builders 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
89e9f199b4 Migrate to py3 style type annotation: sphinx.builders.text 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
f8ddc44c50 Migrate to py3 style type annotation: sphinx.builders.qthelp 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
18924f991d Migrate to py3 style type annotation: sphinx.builders.htmlhelp 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
bedab29832 Migrate to py3 style type annotation: sphinx.builders.xml 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
1ab5e279f8 Migrate to py3 style type annotation: sphinx.builders.applehelp 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
ccdad403c8 Migrate to py3 style type annotation: sphinx.builders.texinfo 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
a2a5bf98df Migrate to py3 style type annotation: sphinx.builders.changes 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
436bc15d09 Migrate to py3 style type annotation: sphinx.builders.manpage 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
dbceb69b43 Migrate to py3 style type annotation: sphinx.builders.gettext 2019-06-10 23:06:08 +09:00
Takeshi KOMIYA
f442de643b Migrate to py3 style type annotation: sphinx.builders.latex.util 2019-06-10 23:06:07 +09:00
Takeshi KOMIYA
f9a74b08f9 Migrate to py3 style type annotation: sphinx.builders.latex.transforms 2019-06-10 23:06:07 +09:00
Takeshi KOMIYA
ec2c8f7194 Migrate to py3 style type annotation: sphinx.builders.latex 2019-06-10 23:06:07 +09:00
Takeshi KOMIYA
cc3022b7f0 Migrate to py3 style type annotation: sphinx.builders.html 2019-06-10 23:06:07 +09:00
Takeshi KOMIYA
eba24eb7ca Merge branch '2.1.2' into 2.0 2019-06-10 22:38:59 +09: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
e0eb86224d Merge branch '2.1.1' into 2.0 2019-06-10 22:31:18 +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
649ebea438 autosummary: deprecate info and warn arguments for generate_autosummary_docs() 2019-06-10 13:45:28 +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
d9d0e49ea9
Merge pull request #6463 from tk0miya/refactor_util_docutils 
refactor: correct interface of directive() and role() to docutils'
 2019-06-09 14:14:15 +09:00
Takeshi KOMIYA
f672e00c08 refactor: correct interface of directive() and role() to docutils' 2019-06-09 13:03:24 +09:00
Takeshi KOMIYA
c80e8cfdd9
Merge pull request #6459 from tk0miya/refactor_type_annotation_directives 
Migrate to py3 style type annotation: sphinx.directives
 2019-06-09 01:28:03 +09:00
Takeshi KOMIYA
5cabe8be35 Merge branch '2.1.1' into 2.0 2019-06-09 00:59:38 +09:00
Takeshi KOMIYA
acab4029af Migrate to py3 style type annotation: sphinx.directives 2019-06-09 00:31:00 +09:00
Takeshi KOMIYA
4db7a81528 Migrate to py3 style type annotation: sphinx.directives.patches 2019-06-09 00:31:00 +09:00
Takeshi KOMIYA
c4dfc7402e Fix #6436: napoleon: "Unknown target name" error 2019-06-09 00:23:18 +09:00