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
c78018cda7
Merge pull request #6492 from tk0miya/5602_apidoc_templating
...
Close #5602 : apidoc: Add ``--templatedir`` option
2019-06-18 22:01:59 +09:00
Takeshi KOMIYA
0b06e3317f
refactor: Separate generate_autosummary_content() from generate_autosummary_docs()
2019-06-18 21:47:23 +09:00
Takeshi KOMIYA
0fb832baa5
Merge pull request #6490 from tk0miya/refactor_autosummary
...
refactor: Separate generate_autosummary_content() from generate_autosummary_docs()
2019-06-18 21:43:03 +09:00
Takeshi KOMIYA
45027677d1
Merge branch '2.0' into 5602_apidoc_templating
2019-06-18 21:42:11 +09:00
Takeshi KOMIYA
aeb9401c20
Merge pull request #6500 from tk0miya/1464_warning_html_static_path_inside_outdir
...
Close #1464 : html: warn html_static_path is inside outdir
2019-06-18 21:39:07 +09:00
Takeshi KOMIYA
288bf231e6
Merge pull request #6501 from tk0miya/6499_html_logo_never_updated
...
Fix #6499 : html: Sphinx never updates a copy of html_logo
2019-06-18 21:38:12 +09: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
Takeshi KOMIYA
83c59bba6d
Fix #6499 : html: Sphinx never updates a copy of html_logo
2019-06-18 01:27:44 +09:00
Takeshi KOMIYA
d8208d406a
Close #1464 : html: warn html_static_path is inside outdir
2019-06-18 01:21:08 +09:00
Takeshi KOMIYA
3047bd211f
Merge pull request #6496 from tk0miya/refactor_html_builder2
...
Refactor html builder: validate config values on config-inited event
2019-06-18 01:20:12 +09:00
Takeshi KOMIYA
fe0f83daf8
validate html_favicon on config-inited
2019-06-17 22:42:45 +09:00
Takeshi KOMIYA
dd8ae7e2ed
validate html_logo on config-inited
2019-06-17 22:42:45 +09:00
Takeshi KOMIYA
eb9bd50d68
validate html_extra_path on config-inited
2019-06-17 22:30:43 +09:00
Takeshi KOMIYA
9bef665cb8
validate html_static_path on config-inited
2019-06-17 22:30:43 +09:00
Takeshi KOMIYA
99d9a6f123
Close #5592 : option directive registers an index entry for each comma separated option
2019-06-16 18:58:34 +09:00
Takeshi KOMIYA
9314e5c38c
Merge pull request #6493 from tk0miya/test_cmdoption
...
Add testcase for option directive
2019-06-16 16:51:05 +09:00
Takeshi KOMIYA
09610fb77e
Add testcase for option directive
2019-06-16 16:37:02 +09:00
Takeshi KOMIYA
a0b4d09b1b
Close #5602 : apidoc: Add `--templatedir
` option
2019-06-16 13:39:21 +09:00
Takeshi KOMIYA
301d0d6060
apidoc: template files are renamed to `.rst_t
`
2019-06-16 13:17:51 +09:00
Takeshi KOMIYA
9ea0f1e042
refactor: Separate generate_autosummary_content() from generate_autosummary_docs()
2019-06-16 01:36:01 +09:00
Takeshi KOMIYA
564d23be7a
Merge pull request #6467 from tk0miya/refactor_math
...
refactor: Add data accessors to MathDomain
2019-06-15 23:48:57 +09:00
Takeshi KOMIYA
5d42659e33
Merge branch '2.0'
2019-06-15 23:39:44 +09:00
Takeshi KOMIYA
d2f0c83568
Merge pull request #6433 from tk0miya/refactor_todo2
...
refactor todo extension with Domain
2019-06-15 23:12:03 +09:00
Takeshi KOMIYA
9b0f415e21
refactor: Add data accessors to MathDomain
2019-06-15 23:05:45 +09:00
Takeshi KOMIYA
fd83dd8c12
Merge pull request #6487 from tk0miya/6486_UnboundLocalError
...
Fix #6486 : UnboundLocalError is raised if broken extension installed
2019-06-15 23:03:21 +09:00
Takeshi KOMIYA
b95d239f68
Fix #6486 : UnboundLocalError is raised if broken extension installed
2019-06-15 18:31:42 +09:00
Takeshi KOMIYA
05c1c4c33a
Merge pull request #6430 from tk0miya/5124_graphviz_layout_option
...
Close #5124 : graphviz: :graphviz_dot: option is renamed to :layout:
2019-06-15 16:46:48 +09:00
Takeshi KOMIYA
f6dfab33d2
Merge branch '2.0' into refactor_todo2
2019-06-15 16:45:17 +09:00
Takeshi KOMIYA
e5881c2344
Add testcase for math directive
2019-06-15 16:39:18 +09:00
Takeshi KOMIYA
5cf84a5505
Merge pull request #6461 from tk0miya/refactor_type_annotation_builders
...
Migrate to py3 style type annotation: sphinx.builders
2019-06-15 14:08:24 +09:00
Takeshi KOMIYA
a7667de917
Merge pull request #6480 from jdufresne/universal
...
Remove "universal" configuration from setup.cfg
2019-06-15 12:43:34 +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
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
af50bfcdf6
Merge pull request #6481 from jdufresne/pkg-resource
...
Remove empty code block in sphinx.util.requests
2019-06-13 23:11:55 +09:00
Takeshi KOMIYA
0d434c5629
Merge branch 'master' into pkg-resource
2019-06-13 22:53:07 +09:00
Takeshi KOMIYA
7d62b9190b
Merge pull request #6479 from jdufresne/unused
...
Remove unused import of InsecurePlatformWarning
2019-06-13 22:43:54 +09:00
Jon Dufresne
13bbbe0484
Remove empty code block in sphinx.util.requests
...
Empty since 19a187cb54
.
If requests is installed with the security extras, they will be loaded
automatically by requests. The is no need to proactively load it. The
block simply did a "pass" in all cases.
2019-06-12 19:22:02 -07:00
Jon Dufresne
2f17e7efee
Remove unused import of InsecurePlatformWarning
...
Unused since 77e0139a26
.
2019-06-12 17:14:14 -07: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