Commit Graph

16526 Commits

Author SHA1 Message Date
Takeshi KOMIYA
a71028bf9e
Merge pull request #8719 from tk0miya/8714_kbd_capslock
Fix #8714: html: kbd role with "Caps Lock" rendered incorrectly
2021-01-22 22:07:06 +09:00
Takeshi KOMIYA
4dd4ff8736
Merge pull request #8726 from markus-oehme-pg40/patch-1
doc: Link to detailed extension documentation
2021-01-22 22:02:13 +09:00
Takeshi KOMIYA
d6f41227d7 Fix #8714: html: kbd role with "Caps Lock" rendered incorrectly
`:kbd:` role has to support keys in consist of multiple words (ex. caps
lock, num lock, etc.)
2021-01-22 21:58:19 +09:00
Takeshi KOMIYA
d5bc970dd9
Merge pull request #8707 from tk0miya/8704_viewcode_not_working
Fix #8704: viewcode: anchors are generated in incremental build
2021-01-22 21:54:25 +09:00
Takeshi KOMIYA
5260143afe Fix #8704: viewcode: anchors are generated in incremental build
The anchors for viewcode was generated in the reading phase only if
supported builder is used.  It causes anchors are missing on the
incremental build after the build for non supported builder.

This introduces `viewcode_anchor` node to insert the anchor even if non
supported builders.  They will be converted to the anchor tag in the
resolving phase for supported builders.  Or, they will be removed for
non supported builders.
2021-01-22 21:41:42 +09:00
Takeshi KOMIYA
d5d072bc3a Merge branch '3.4.x' into 3.x 2021-01-22 21:40:27 +09:00
Takeshi KOMIYA
aebfbbb532
Merge pull request #8728 from tk0miya/mypy-0.800
Fix mypy violations (with mypy-0.800)
2021-01-22 21:39:01 +09:00
Takeshi KOMIYA
1679a0916d Fix mypy violations (with mypy-0.800) 2021-01-22 21:26:58 +09:00
Takeshi KOMIYA
86c75cea13
Merge pull request #8721 from tk0miya/8720_viewcode_incremental_build
Fix #8720: viewcode: module pages are generated for epub on incremental build
2021-01-22 21:14:00 +09:00
Markus Oehme
eddce3019f ci: force empty commit to rerun ci. 2021-01-22 09:54:53 +01:00
markus-oehme-pg40
e59365923b
doc: Link to detailed extension documentation
I missed that there are actually two sections explaining extensions in the docs and just saw the examples based one. This lead to me thinking "kind of lousy documentation, but that's probably par for the course". Would there have been a pointer to the detailed extension API description it would have saved me hours of guesswork.
2021-01-22 09:29:19 +01:00
Takeshi KOMIYA
b9f603da5f
Merge pull request #8723 from francoisfreitag/unused-attrs-linkcheck
Deprecate linkcheck builder {broken,good,redirected}
2021-01-22 02:50:06 +09:00
Takeshi KOMIYA
2308695d24
Merge branch '3.x' into unused-attrs-linkcheck 2021-01-22 02:41:32 +09:00
Takeshi KOMIYA
fc3fdb8bb8
Merge pull request #8722 from francoisfreitag/typo
Match linkcheck deprecation warning version with deprecated.rst
2021-01-22 01:26:48 +09:00
Takeshi KOMIYA
a5b0d96c70
Merge branch '3.x' into typo 2021-01-22 01:15:53 +09:00
François Freitag
aa5e4e2da0 Deprecate linkcheck builder {broken,good,redirected}
These attributes were used to cache checked links and avoid issuing
another web request to the same URI.

Since 82ef497a8c, links are pre-processed
to ensure uniqueness. This caching the results of checked links is no
longer useful.
2021-01-21 17:06:51 +01:00
Takeshi KOMIYA
3b9f5a2aa0
Merge pull request #8715 from jfbu/fix_latexrst_markup
Fix some mark-up issues in latex.rst with "Default:" lines
2021-01-22 00:57:30 +09:00
Takeshi KOMIYA
cf3c92b8fe
Merge pull request #8712 from tk0miya/refactor_linkcheck
refactor: linkcheck: Make linkcheck builder to a subclass of DummyBuilder
2021-01-22 00:54:37 +09:00
Takeshi KOMIYA
b2bb12ad91 Fix #8720: viewcode: module pages are generated for epub on incremental build
The module pages should be generated for epub only if enabled via
configuration.  But they are generated after the build for other
viewcode-supported builders.  This checks the current builder on
generating module pages.
2021-01-22 00:51:21 +09:00
François Freitag
52fde7e7b1 Match linkcheck deprecation warning version with deprecated.rst
Deprecated.rst states the node_line_or_0 helper will be removed in
Sphinx 5.0, use a RemovedInSphinx50Warning.
2021-01-21 16:39:40 +01:00
jfbu
59694da63a Fix some mark-up issues in latex.rst with "Default:" lines 2021-01-20 21:15:52 +01:00
Takeshi KOMIYA
bd103a82c9 refactor: linkcheck: Make linkcheck builder to a subclass of DummyBuilder
After recent refactoring, the linkcheck builder does not do "writing".
So it would be better to inherit the DummyBuilder.
2021-01-20 21:37:23 +09:00
Takeshi KOMIYA
82ef497a8c
Merge pull request #8702 from tk0miya/4304_linkcheck_same_url
linkcheck: Do not check the availability of the same URL repeatedly
2021-01-20 21:12:22 +09:00
Takeshi KOMIYA
cead0f6ddf linkcheck: Fix race condition that could lead to checking the availability of the same URL twice
So far, linkcheck scans all of references and images from documents, and
checks them parallel.  As a result, some URL would be checked twice (or
more) by race condition.

This collects the URL via post-transforms, and removes duplicated URLs
before checking availability.

refs: #4303
2021-01-20 20:58:27 +09:00
Takeshi KOMIYA
42de5e2888
Merge pull request #8710 from chrisjsewell/patch-2
minor typing fix
2021-01-20 20:56:22 +09:00
Takeshi KOMIYA
8a0ec3b7a4
Merge pull request #8708 from tk0miya/refactor_autosummary
refactor: autosummary: Deprecate _simple_info() and _simple_warn()
2021-01-20 20:53:53 +09:00
Chris Sewell
088d059196
minor typing fix 2021-01-20 04:43:39 +00:00
Jakob Lykke Andersen
67c4ca6b21
Merge pull request #8706 from jakobandersen/cpp_operator
C++, also hyperlink operators in expr and alias
2021-01-19 19:04:13 +01:00
Takeshi KOMIYA
d49f3a1c78 refactor: autosummary: Deprecate _simple_info() and _simple_warn() 2021-01-20 02:23:34 +09:00
Jakob Lykke Andersen
ab7562513b C++, also hyperlink operators in expr and alias 2021-01-19 17:45:28 +01:00
Takeshi KOMIYA
a7b6b6bb7f
Merge pull request #8703 from tk0miya/refactor_viewcode2
refactor: viewcode: Fix type annotations
2021-01-19 21:18:59 +09:00
Takeshi KOMIYA
ef7f57325c Update CHANGES for PR #8658 2021-01-19 21:17:26 +09:00
Takeshi KOMIYA
ca0677086d
Merge pull request #8658 from SolidifiedRay/feature-custom-section
Close #8573: napoleon: Add more custom section styles
2021-01-19 21:13:13 +09:00
SolidifiedRay
7ad85cd1e0 Close #8573: napoleon: Add more custom section styles 2021-01-18 11:43:40 -08:00
Takeshi KOMIYA
84150b2106 refactor: viewcode: Fix type annotations 2021-01-19 02:51:03 +09:00
Takeshi KOMIYA
40f2c832ff
Merge pull request #8698 from tk0miya/8681_viewcode_incremental_build
Close #8681: viewcode: Support incremental build
2021-01-19 02:42:21 +09:00
Takeshi KOMIYA
9f7998b66d
Merge pull request #8697 from tk0miya/1112_download_duplicated_copies
Fix #1112: download role creates duplicated copies
2021-01-19 02:40:54 +09:00
Takeshi KOMIYA
a7e77c01e4
Merge pull request #8699 from tk0miya/refactor_viewcode
refactor: viewcode: Use a constant for dirname
2021-01-19 02:30:49 +09:00
Takeshi KOMIYA
2e01c34acf Close #8681: viewcode: Support incremental build
Now viewcode supports incremental build. It generates HTML files only
when the original python code is updated from last build.
2021-01-19 02:30:11 +09:00
Takeshi KOMIYA
bc56384fb9 Fix #1112: download role creates duplicated copies
`:download:` role creates duplicated copies when the document contains
two or more the role for the same file, but in different form.  It
considers two paths are different when one contains relative path like
`path/to/../file.dat`.

Internally, `env.relfn2path()` does not normalize the given path in
relative form.  As a result, download role can't detect the same paths
are given.  This adds `os.path.normpath()` to `env.relfn2path()` to
normalize the path.
2021-01-19 02:27:20 +09:00
Takeshi KOMIYA
de0a4ee198 refactor: viewcode: Use a constant for dirname 2021-01-18 02:19:30 +09:00
Takeshi KOMIYA
596dfba841
Merge pull request #8695 from tk0miya/8514_default_value_of_overloads
Close #8514: autodoc: Default values of overloads are taken from actual implementation
2021-01-18 00:15:56 +09:00
Takeshi KOMIYA
240f7550ae
Merge pull request #8694 from tk0miya/8693_defvalue_for_overloaded_functions
Fix #8693: autodoc: Default values for overloads are rendered as string
2021-01-18 00:14:20 +09:00
Takeshi KOMIYA
2e660fbcb4
Merge pull request #8692 from tk0miya/refactor_writers
refactor: Remove meaningless variable: attrs
2021-01-17 19:27:21 +09:00
Takeshi KOMIYA
d88166e84b Close #8514: autodoc: Default values of overloads are taken from actual implementation
As a well-known idiom, mypy recommends to use ellipsis ("...") for
default argument values as a elided style.  This allows to write the
style and helps to document it with copying the default argument
values from actual implementation.

Note: This does not copy the default argument value when the argument
of overloaded function has its own default value.
2021-01-17 02:32:50 +09:00
Takeshi KOMIYA
425cd1af02 Fix #8693: autodoc: Default values for overloads are rendered as string
The default values for overloaded functions are rendered as string
literal unexpectedly because autodoc extracts code snippets from
the source code, not actual value (ex. int, ellipsis, and so on).

This introduces a simple wrapper class; `DefaultValue` to render these
code snippets like actual values, not string literals.
2021-01-17 02:30:20 +09:00
Takeshi KOMIYA
8f5744be5e refactor: Remove meaningless variable: attrs
It would be better to use `name in node` and `node[name]` to check and
access an attribute of the node instead of `node.attributes`.
2021-01-16 22:46:18 +09:00
Takeshi KOMIYA
7c340e1c1c
Merge pull request #8691 from tk0miya/add_readthedocs.yml
Fix #8662: Add .readthedocs.yml
2021-01-16 21:42:18 +09:00
Takeshi KOMIYA
90ab89311f
Merge pull request #8667 from tk0miya/8652_invalid_type_comments
Fix #8652: autodoc: variable comments are ignored if invalid type comments found
2021-01-16 21:40:34 +09:00
Takeshi KOMIYA
8ce830e1cb Fix #8662: Add .readthedocs.yml 2021-01-16 21:31:50 +09:00