Adam Turner
78c478a579
Merge remote-tracking branch 'upstream/5.0.x' into lang-none-en
2022-05-28 19:21:44 +01:00
Takeshi KOMIYA
68252c646a
doc: The default setting of "language" has been changed since v5.0
2022-05-28 19:09:35 +01:00
Takeshi KOMIYA
06436084dd
Merge pull request #10464 from tk0miya/10461_doc_code-block_class_option
...
doc: Add an explanation for :class: option of code-block directive
2022-05-28 23:15:08 +09:00
Takeshi KOMIYA
cab2d93076
Merge pull request #10386 from mxd4/10384-comment-img-magick
...
Add comments on ImageMagick requirement
2022-05-22 19:22:24 +09:00
Takeshi KOMIYA
1856ee638b
Close #10461 : doc: Add an explanation for :class: option of code-block directive
2022-05-22 16:03:33 +09:00
Takeshi KOMIYA
425a3e6c09
Merge branch '4.x' into 5.x
2022-05-06 03:32:43 +09:00
Takeshi KOMIYA
3805e0646f
Merge pull request #10251 from jbms/fix-inline-syntax-highlight
...
Make code role highlighting consistent with code-block directive
2022-05-06 02:54:42 +09:00
Takeshi KOMIYA
538fdb23bb
Merge pull request #10388 from soxofaan/patch-1
...
sphinx.ext.napoleon docs: fix Google style link
2022-05-03 01:53:58 +09:00
mxd4
33b5e23467
#10384 - Grammar
2022-05-02 13:56:51 +02:00
mxd4
4fc196a2a5
#10384 - Fix flake8
2022-05-02 12:26:16 +02:00
mxd4
4d840c790c
#10384 - Explicit warning and improve doc clarity
2022-05-02 12:18:30 +02:00
mxd4
d2d5ce4eb6
#10384 - Changes after suggestions
2022-05-02 11:29:11 +02:00
mxd4
85524b5817
#10384 - Add line break to fix docslint
2022-05-02 11:15:29 +02:00
mxd4
930056479f
#10384 - Add comment on ImageMagick requirement
2022-05-02 10:47:56 +02:00
Stefaan Lippens
b98b1b3419
sphinx.ext.napoleon docs: fix Google style link
2022-04-25 12:35:40 +02:00
Adam Turner
3420d15cb9
Bump Docutils dependency
2022-04-19 03:09:45 +01:00
Takeshi KOMIYA
da73960492
Merge branch '5.x' into autodoc_force_undocumented_rtype
2022-04-03 22:45:42 +09:00
Takeshi KOMIYA
fd42063725
autodoc_typehints_description_target: Rename returnvalue_and_documented_params to documented_params
2022-04-03 22:42:44 +09:00
Takeshi KOMIYA
f731bf1999
Merge branch '5.x' into autodoc_force_undocumented_rtype
2022-04-03 22:29:22 +09:00
Takeshi KOMIYA
21e3a96f09
Close #8417 : autodoc: :inherited-members: option now takes multiple classes
...
It allows to suppress inherited members of several classes on the module at
once by specifying the option to `automodule` directive
2022-04-03 20:17:41 +09:00
Takeshi KOMIYA
223b1a94f2
Merge branch '4.x'
2022-03-28 01:00:37 +09:00
Takeshi KOMIYA
b20e04968e
Merge pull request #10107 from Jean-Abou-Samra/intl-warnings
...
Implement #noqa for i18n
2022-03-27 23:00:57 +09:00
Takeshi KOMIYA
2db180da70
Merge branch '4.x'
2022-03-27 19:47:11 +09:00
Takeshi KOMIYA
c6230dc4db
extlinks: Disable hardcoded links detector by default (refs: #10126 )
...
The hardcoded links detector added since 4.4.0 causes troubles in many
projects. Therefore, this disables it by default, and adds a new
configuration `extlinks_detect_hardcoded_links` to enable it explicitly.
2022-03-27 15:22:11 +09:00
Takeshi KOMIYA
fbdfade068
doc: Use :pep: role to refer PEP documents
2022-03-27 01:46:22 +09:00
Hugo van Kemenade
a432bf8c10
Update PEP links in docs
2022-03-24 12:34:05 +02:00
Jeremy Maitin-Shepard
099b54cb87
Make code role highlighting consistent with code-block directive
...
Fixes https://github.com/sphinx-doc/sphinx/issues/5157
This is factored out of the sphinx-immaterial theme:
1ef121a612/sphinx_immaterial/inlinesyntaxhighlight.py (L1)https://github.com/sphinx-doc/sphinx/pull/6916
2022-03-19 20:37:49 -07:00
Takeshi KOMIYA
aa1bc83c2a
Merge branch '4.x'
2022-03-19 22:58:15 +09:00
Takeshi KOMIYA
7b55447b7e
Update versionadded to 4.5
2022-03-06 18:47:17 +09:00
Takeshi KOMIYA
fa63db8dc6
Update versionadded to 4.5
2022-03-06 18:47:11 +09:00
Takeshi KOMIYA
08f5d97a82
Fix #10223 : doc: Add descriptions of :module: option for python directives
2022-03-06 16:10:40 +09:00
Takeshi KOMIYA
f72cd83e4d
Merge branch '4.x'
2022-02-19 16:08:05 +09:00
Jean Abou Samra
94d78d8747
Close #3985 : Implement #noqa for i18n
...
When cross-references in the original paragraph and the translated
paragraph do not match, a warning is emitted. It is useful, because
it allows to catch mistakes, but it can also be an annoyance since
sometimes it is expected that the cross-references will not match.
For example, a reference that is repeated in the original text may
need to be factored out for good style in the target language.
Another example: if the translator needs to translate a universally
understood term in the source language into a term that not everyone
knows is the translation of this original term, adding a reference to
the glossary can be warranted. This allows the translated message to
start with '#noqa' in order to disable the warning.
2022-02-15 19:51:06 +01:00
Takeshi KOMIYA
1cb5a3b5fa
Merge commit '799385f5558a888d1a143bf703d06b66d6717fe4'
2022-02-16 00:25:53 +09:00
Jean Abou Samra
dfcb5d2f4c
Categorize warnings for inconsistent references in i18n
...
This allows suppressing them using the suppress_warnings configuration
variable.
2022-02-15 14:32:22 +01:00
Takeshi KOMIYA
8b23f6db12
Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9'
2022-02-14 03:03:40 +09:00
Takeshi KOMIYA
d7c6fa853c
Merge commit '2be06309518d9401a42880bb5b4321dfdd1e5e90'
2022-02-14 03:02:31 +09:00
Takeshi KOMIYA
680417a10d
Merge pull request #10150 from tk0miya/10146_autodoc_default_options_should_support_no-value
...
Close #10146 : autodoc: autodoc_default_options does not support `no-value` option
2022-02-06 15:59:24 +09:00
Takeshi KOMIYA
7469096e0a
Update doc/usage/extensions/autodoc.rst
2022-02-06 15:30:54 +09:00
Noah Sprent
25c4287da5
Remove commas when describing characters for section headings
2022-02-02 10:52:06 +01:00
Takeshi KOMIYA
b0b51cecc2
Close #10146 : autodoc: autodoc_default_options does not support no-value option
2022-01-31 01:51:37 +09:00
Takeshi KOMIYA
799385f555
Merge pull request #9337 from marxin/new-shortcuts
...
Implement new search shortcuts.
2022-01-31 00:11:45 +09:00
Timo Cornelius Metzger
8f39f29725
Update autosummary.rst
2022-01-27 20:22:45 -08:00
Martin Liska
8cf3179ad2
Implement new shortcuts:
...
- "/" for Focus search bar
- "ESC" - clear highlighted text
Fixes #691 .
Co-authored-by: Jakob Lykke Andersen <jakobandersen@users.noreply.github.com>
2022-01-22 16:16:35 +01:00
Takeshi KOMIYA
72bb5c998f
Close #9456 : html search: Add a config variable; html_show_search_summary
...
refs: #9494
2022-01-17 01:44:42 +09:00
Takeshi KOMIYA
444dfc50aa
Merge branch '4.x'
2022-01-17 00:22:09 +09:00
Jakob Lykke Andersen
3bf8bcd6e1
intersphinx role, update docs
2022-01-16 09:48:20 +01:00
Jakob Lykke Andersen
540d76035c
intersphinx role, documentation
2022-01-16 09:48:06 +01:00
Takeshi KOMIYA
6a0215198f
Merge branch '4.x'
2022-01-16 02:26:11 +09:00
Takeshi KOMIYA
6611140c76
Merge branch '4.x' into HEAD
2022-01-15 19:46:45 +09:00
