Takeshi KOMIYA
f9dce5764e
Mark sphinx.io:read_doc() deprecated
2022-05-08 02:15:58 +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
21fb2caad6
Merge pull request #10412 from tk0miya/deprecate_sphinx.util.docutils.__version_info__
...
Remove sphinx.util.docutils.__version_info__ on 7.0
2022-05-05 19:46:58 +09:00
Takeshi KOMIYA
e4f78df2fc
Merge pull request #10345 from Thecarisma/fix-theming-add-static-file-documentation
...
Refractor the example in 'Add your own static files to the build assets' documentation section
2022-05-03 02:10:57 +09:00
Takeshi KOMIYA
be212d98df
Remove sphinx.util.docutils.__version_info__ on 7.0
2022-05-03 02:07:47 +09:00
Takeshi KOMIYA
8e726db3de
Merge pull request #10381 from tk0miya/deprecation_for_docutils-0.13
...
Mark APIs for docutils-0.13 deprecated and remove monkey-patch for it
2022-05-03 02:06:13 +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
Takeshi KOMIYA
3aa7e4105a
Deprecate: html5_ready and is_html5_writer_available()
2022-05-03 01:48:17 +09:00
Adam Turner
971040b4b7
Merge branch '5.x' into fix-warnings
...
# Conflicts:
# tests/test_search.py
2022-05-02 17:05:42 +01:00
Takeshi KOMIYA
b58a584236
Merge pull request #10164 from AA-Turner/bump-docutils
...
Bump Docutils dependency
2022-05-03 01:00:51 +09:00
Adam Turner
3f8bf7acb1
Schedule removal for 7.0
2022-04-30 19:10:27 +01:00
Adam Turner
b536ffabc1
Deprecate sphinx.util.jsdump
2022-04-27 02:59:50 +01:00
Stefaan Lippens
b98b1b3419
sphinx.ext.napoleon docs: fix Google style link
2022-04-25 12:35:40 +02:00
Adam Turner
35ed39c946
Use Node.findall
2022-04-22 04:21:39 +01:00
Adam Turner
cbe0c99181
rawsource is deprecated in docutils.nodes.Text
2022-04-22 04:21:38 +01:00
Adam Turner
3420d15cb9
Bump Docutils dependency
2022-04-19 03:09:45 +01:00
Takayuki SHIMIZUKAWA
068f802df9
fix typo
...
from https://github.com/sphinx-doc/sphinx-doc-translations/pull/13
2022-04-19 04:10:39 +09:00
Takeshi KOMIYA
26e00bda0e
Merge branch '5.x' into sphinx-docs-build
2022-04-17 11:53:15 +09:00
Adam Turner
22f7a0124c
Update documentation
2022-04-16 21:12:18 +01:00
Adam Turner
ec0c13c26d
Don't use deprecated setup.py build_sphinx
2022-04-16 19:08:27 +01:00
Adewale Azeez
02074f8ed4
Fix the example in 'Add your own static files to the build assets' documentation section
2022-04-14 01:52:37 +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
f559389d14
Merge pull request #10301 from tk0miya/refactor_parserapi_doc
...
doc: Update docs for sphinx.parsers.Parser
2022-03-27 19:45:41 +09:00
Takeshi KOMIYA
e530c00b82
doc: Update docs for sphinx.parsers.Parser
2022-03-27 19:27:53 +09:00
Takeshi KOMIYA
7ae8c1ee42
Merge pull request #10300 from tk0miya/doc_URL_changed
...
doc: URL of requests has changed now
2022-03-27 16:21:03 +09:00
Takeshi KOMIYA
7ffc606e0c
doc: URL of requests has changed now
2022-03-27 16:13:15 +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
4e9c1017ed
Merge pull request #10260 from hugovk/colour-env-vars
...
Enable FORCE_COLOR and NO_COLOR for terminal colouring
2022-03-17 00:38:57 +09:00
Hugo van Kemenade
cdf9456699
Document NO_COLOR and FORCE_COLOR environment variables
2022-03-13 17:43:22 +02: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
Carlton Gibson
3de086fb35
Fixed typo.
...
Should read `…an info field list…`, rather than ``…a info field list…`.
2022-02-23 20:29:50 +01: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
