Commit Graph

519 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f9dce5764e Mark sphinx.io:read_doc() deprecated 2022-05-08 02:15:58 +09:00
Takeshi KOMIYA
be212d98df Remove sphinx.util.docutils.__version_info__ on 7.0 2022-05-03 02:07:47 +09:00
Takeshi KOMIYA
3aa7e4105a Deprecate: html5_ready and is_html5_writer_available() 2022-05-03 01:48:17 +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
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
2db180da70 Merge branch '4.x' 2022-03-27 19:47:11 +09:00
Takeshi KOMIYA
e530c00b82 doc: Update docs for sphinx.parsers.Parser 2022-03-27 19:27:53 +09:00
Takeshi KOMIYA
f72cd83e4d Merge branch '4.x' 2022-02-19 16:08:05 +09:00
Takeshi KOMIYA
8b23f6db12 Merge commit '07110b7557a552ecfe702bdd6a2d2f9685cb1af9' 2022-02-14 03:03:40 +09:00
Takeshi KOMIYA
8224f6f44a Fix #10181: napoleon_use_ivar adds unexpected prefix to vars
Since 4.0, :ivar: items has not been rendered as hyperlinks.  So any
modules, classes and tilda are now harmful.  This removes the prefixing
filter for napoleon_use_ivar option.

refs: #5129 and #5977
2022-02-12 00:50:56 +09:00
Hinrich Mahler
84a6270685 Mention nitpick_ignore(_regex) in docs of warn-missing-reference 2022-01-18 22:01:52 +01:00
Takeshi KOMIYA
e4e58a4f27 Close #10062: Change the default language to 'en'
Change the default language to `'en'` if any language is not set in
`conf.py`.
2022-01-12 02:45:52 +09:00
Takeshi KOMIYA
0663602bb9 Close #9595: Deprecate setuptools integration 2022-01-01 20:19:27 +09:00
Takeshi KOMIYA
26cd8f100c Deprecate sphinx.writers.latex.LaTeXWriter.docclasses 2021-12-18 02:24:03 +09:00
Takeshi KOMIYA
b778ee806e Fix #9752: autodoc: Failed to detect type annotation for slots attribute 2021-10-23 14:59:36 +09:00
Takeshi KOMIYA
dd2ff3e911 Fix #9710: html: Wrong styles for even/odd rows in nested tables 2021-10-09 16:35:31 +09:00
Takeshi KOMIYA
0424da31ab
Merge branch '4.x' into 9683_add_css_file 2021-10-09 13:58:10 +09:00
Jakob Lykke Andersen
1fe87938e2 js nodes, docs, add entry in deprecation/removal table 2021-10-03 10:18:51 +02:00
Takeshi KOMIYA
1fbca49970 Close #9683: Revert the removal of `add_stylesheet()` API
It will be kept until the Sphinx-6.0 release.

Note: Now it emits a warning instead of DeprecationWarning to let the
users know the deprecation.
2021-10-03 16:34:57 +09:00
Takeshi KOMIYA
c0333d4464
Merge pull request #9666 from tk0miya/9662_docs_for_ObjectDescription
Add doc for ObjectDescription (refs: #9662)
2021-09-27 01:57:36 +09:00
Takeshi KOMIYA
9543962da6 Add doc for ObjectDescription (refs: #9662) 2021-09-23 12:56:09 +09:00
Takeshi KOMIYA
29ac4c1982 Fix #9637: Add Builder.allow_parallel to the list of builder APIs 2021-09-18 01:26:12 +09:00
Eisuke Kawashima
652ebf1bf5
Fix typo 2021-07-08 08:16:22 +09:00
Takeshi KOMIYA
ec351bdf3d Merge branch '4.0.x' into 4.x 2021-06-30 21:24:06 +09:00
Takeshi KOMIYA
62f128700e Fix #9032: docs: sphinx.environment.NoUri was removed at v3.0.0
Our deprecation list describes `sphinx.environment.NoUri` was removed at
v4.0.0.  But, acutally, it was removed at v3.0.0 (#6223).
2021-06-14 02:18:01 +09:00
Takeshi KOMIYA
519cc078fd Revert the removal of sphinx.util:force_decode()
After the release of 4.0.0, some 3rd party extensions have became not
working with the latest Sphinx because `force_decode()` function was
removed.  It was deprecated since Sphinx-2.0 and warned for the removal
since 3.0.

This reverts the removal and extends its deprecation period to 5.0.0.  I
hope it helps users of these extensions.
2021-06-13 16:31:33 +09:00
Takeshi KOMIYA
b6245266ab
Merge pull request #9303 from tk0miya/fix_docslint
doc: Fix docslint misunderstanding scope of code-blocks
2021-06-06 13:33:17 +09:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +09:00
Takeshi KOMIYA
1418e3acbb
Merge pull request #9260 from tk0miya/9016_linkcheck_github_anchors
Close #9016: linkcheck builder failed to check the anchors of github.com
2021-06-04 01:18:22 +09:00
Takeshi KOMIYA
92335bd6e6 Close #9016: linkcheck builder failed to check the anchors of github.com 2021-06-01 00:31:15 +09:00
Takeshi KOMIYA
46c2e45aa6 deprecate sphinx.ext.autosummary._app 2021-05-31 02:09:10 +09:00
Takeshi KOMIYA
abe5ab4fa7
Merge pull request #9242 from tk0miya/refactor_env2
refactor: Make the app argument for BuildEnvironment required
2021-05-22 02:22:42 +09:00
Takeshi KOMIYA
63fbfb02f1 refactor: Make the app argument for BuildEnvironment required
At present, some attributes of env object are considered as optional
because they have been initialized by None on the constructor.  But
they have always been fullfilled actually.

To be clear the type hints of the env object, this makes the `app`
argument for the BuildEnvironment class required.  It can ensure the
attributes of env object are not optional.
2021-05-22 02:09:49 +09:00
igo95862
7554ad9593
doc: Upgraded babel.pocoo.org links to HTTPS 2021-05-16 16:37:51 +03:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS
Also change any docutils.sourceforge.net link to io
top level domain.
2021-05-16 15:53:49 +03:00
Takeshi KOMIYA
5078069eb1 Deprecate app.html_themes
The register is much better to store the HTML themes instead of the
application object.  So this migrates it to the registry object.
2021-05-12 01:36:14 +09:00
Dmitry Shachnev
356f7c53e2 Fix typos in doc/extdev/deprecated.rst 2021-05-09 20:14:38 +03:00
Takeshi KOMIYA
469def56b6 Fix #8597: autodoc: metadata only docstring is treated as undocumented
The metadata in docstring is invisible content. Therefore docstring
having only metadata should be treated as undocumented.
2021-05-02 23:17:58 +09:00
Takeshi KOMIYA
8ec937d4c9
Merge pull request #9050 from tk0miya/8829_whats_parallel_read_safe
Close #8829: doc: Update description of paralle-read-safe
2021-04-18 15:22:19 +09:00
Jakob Lykke Andersen
98800be904 Decl styling, make desc_inline node
Use the new node for cpp:expr
2021-04-12 19:06:44 +02:00
Jakob Lykke Andersen
3c9a74cb0b Decl styling, docs and restructuring 2021-04-12 19:05:58 +02:00
Takeshi KOMIYA
02016c0ef2 Close #8829: doc: Update description of paralle-read-safe 2021-04-04 13:35:12 +09:00
Brecht Machiels
ac0dcddeb8
Docs: fix typo in env-merge-info 2021-03-30 16:44:50 +02:00
Takeshi KOMIYA
6007bbf797 Deprecate DocumenterBridge.warn()
Since 1.6, sphinx.util.logging module became the default logging
interface of Sphinx. It allows sphinx-components to output log
without the app (or env) object.  According to the policy,
DocumenterBridge.warn() is no longer needed and should be replaced by
the logging module.
2021-03-22 23:51:54 +09:00
Takeshi KOMIYA
cb654d287b Rename DocumenterBridge.filename_set to record_dependencies
DocumenterBridge.filename_set has been used since its beginning.  On the
other hand, in docutils, record_dependencies attribute is well-used to
store the list of dependency files.  So this renames it to docutils'
standard attribute.
2021-03-21 00:52:53 +09:00
Takeshi KOMIYA
a523a89663 refactor: Add a type alias for the option_spec of directives; OptionSpec 2021-03-13 17:15:12 +09:00
Takeshi KOMIYA
fb4220d0a2 Close #8487: csv-table now considers abspath as relpath from srcdir
To make directives' behavior consistent, the :file: option for
csv-table directive now recognizes an absolute path as a relative
path from source directory.
2021-03-09 01:07:19 +09:00
Takeshi KOMIYA
0a3f897d15
Merge pull request #8432 from tk0miya/7119_pending_xref_condition
Fix #7119: Show type hint names unqualified when resolving succeeded
2021-03-06 17:32:27 +09:00
Takeshi KOMIYA
e1130972b2 Add pending_xref_condition node
To choose appropriate content for pending_xref node on resolving,
this introduces a new custom node `pending_xref_condition`.  It only
has a condition for the filtering and contents of the reference.
2021-03-06 02:01:03 +09:00