Commit Graph

207 Commits

Author SHA1 Message Date
Takeshi KOMIYA
223b1a94f2 Merge branch '4.x' 2022-03-28 01:00:37 +09:00
Takeshi KOMIYA
7b55447b7e
Update versionadded to 4.5 2022-03-06 18:47:17 +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
d7c6fa853c Merge commit '2be06309518d9401a42880bb5b4321dfdd1e5e90' 2022-02-14 03:02:31 +09: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
0e51ddef34 Merge branch '4.x' 2021-12-11 23:18:46 +09:00
Takeshi KOMIYA
8d071a8e8f
Merge branch '4.x' into texinfo-add-texinfo_emit_document_references 2021-12-11 10:27:50 +09:00
Takeshi KOMIYA
980ccc4c2a Merge branch '4.x' 2021-12-10 01:45:15 +09:00
Christian Roth
10023da895 linkcheck: Exclude links from matched documents 2021-12-08 10:01:45 +01:00
Takeshi KOMIYA
ecee2335c5 Merge branch '4.x' 2021-11-18 01:01:12 +09:00
Matt Ficke
2ed4bed33a Update RFC base url
The tools.ietf.org subdomain is being wound down and services are moving to
datatracker.ietf.org. Links to RFC documents using the old subdomain are being
redirected to datatracker; this updates the configured `rfc_base_url` to
point to the current subdomain.

Discussion: https://mailarchive.ietf.org/arch/msg/ietf/0n-6EXEmkTp3Uv_vj-5Vnm3o0bo/
2021-11-16 10:52:02 -05:00
Martin Liska
9ec829fb50 texinfo: simplify reference emission.
The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.

Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.

while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.

It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
2021-11-12 14:00:48 +01:00
Takeshi KOMIYA
0f6afa5992 Merge branch '4.x' 2021-11-11 02:25:42 +09:00
Takeshi KOMIYA
096e28693e
Merge pull request #9628 from tk0miya/9623_suppress_warnings_for_excluded_document_in_toctree
Close #9623: Allow to suppress warnings on excluded document found in toctree
2021-11-10 02:17:04 +09:00
Takeshi KOMIYA
7357b17e09 Merge branch '4.x' into 9623_suppress_warnings_for_excluded_document_in_toctree 2021-11-10 01:44:28 +09:00
Takeshi KOMIYA
22bec4ffe4 Fix #9623: Separate warning type 'toc.not_readable' to 'toc.excluded' 2021-11-10 01:43:59 +09:00
Takeshi KOMIYA
203094b4c3 Close #9618: i18n: Add gettext_allow_fuzzy_translations 2021-11-10 01:32:02 +09:00
Takeshi KOMIYA
4c623237c1 Merge branch '4.x' 2021-10-28 02:43:32 +09:00
François Freitag
70e0c314ca Fix linkcheck_auth link to Requests authentication
The link was directing to
https://www.sphinx-doc.org/en/master/usage/requests-auth>. Prefer using
the intersphinx module to generate the link, it’s more robust than
directly linking to the page.
2021-10-25 15:04:15 +02:00
Takeshi KOMIYA
3f51f1a6cf Merge branch '4.x' 2021-10-09 13:50:50 +09:00
Ghassan Maslamani
d20646194c doc: update description
Update description about how `conf.py` is loaded/executed
2021-09-30 13:43:09 +03:00
Takeshi KOMIYA
ca146ac18b Close #9623: Allow to suppress warnings on excluded document found in toctree 2021-09-12 19:23:19 +09:00
Takeshi KOMIYA
3d8fbd992c Merge branch '4.x' 2021-09-12 16:56:34 +09:00
Takeshi KOMIYA
260f217a3d
Merge pull request #9594 from hkuno/pr/no_empty_desc_4.x
let user skip printing command description
2021-09-11 19:08:37 +09:00
Jon Dufresne
7dd112b110 Update Sphinx url: s|https?://sphinx-doc\.org/|https://www.sphinx-doc.org/|g
https://sphinx-doc.org is unreachable, but is linked from the PyPI page:
https://pypi.org/project/Sphinx/. Switch to https://www.sphinx-doc.org/
instead.
2021-09-06 13:15:48 -07:00
Harumi Kuno
d0e014b4bc Omit NAME section if blank description
Also, update man page for configuration to document that
if a blank description is entered, the "NAME" section is an
empty string.

Signed-off-by: Harumi Kuno <harumi.kuno@hpe.com>
2021-09-05 17:42:03 -07:00
Takeshi KOMIYA
d194e0f490 Merge branch '4.x' 2021-08-21 21:03:30 +09:00
Takeshi KOMIYA
12cf4ebc1f
Merge pull request #9545 from aaugustin/4.x
Update link to OpenSearch.
2021-08-14 22:37:34 +09:00
Aymeric Augustin
56add529ec
Update link to OpenSearch.
Amazon repurposed the opensearch.org domain.

It is now hosting their ElasticSearch fork.
2021-08-14 11:49:34 +02:00
Kevin Anderson
cfd5536b27 fix typo in numfig_format default value 2021-08-13 07:20:16 -06:00
Darren Ng
8ea5587ed9
:manpage: is a role, not a directive. [ci skip] 2021-07-26 16:33:18 +08:00
Takeshi KOMIYA
5e5bca98f7
Merge branch '4.x' into 6525_linkcheck_warn_redirects 2021-07-07 02:09:50 +09:00
Takeshi KOMIYA
ec351bdf3d Merge branch '4.0.x' into 4.x 2021-06-30 21:24:06 +09:00
Jakob Lykke Andersen
50f5280603 C, keyword changes
- Add new keywords from C23.
- Add c_extra_keywords as confval.
- Move macro names from keywords to c_extra_keywords.

Fixes sphinx-doc/sphinx#9354
2021-06-17 08:29:39 +02:00
Takeshi KOMIYA
988a79de65 linkcheck: Emit a warning for disallowed redirects
Now linkcheck builder integrates `linkcheck_warn_redirects` into
`linkcheck_allowed_redirects`.  As a result, linkcheck builder will
emit a warning when "disallowed" redirection detected via
`linkcheck_allowed_redirects`.
2021-05-31 21:53:09 +09:00
Takeshi KOMIYA
2887dd07df
doc: Fix indentation 2021-05-31 02:59:35 +09:00
Takeshi KOMIYA
48c80b17b4
doc: Fix indentation 2021-05-31 02:58:29 +09:00
Takeshi KOMIYA
676834b998
Merge branch '4.x' into 6525_linkcheck_warn_redirects 2021-05-31 02:54:41 +09:00
Takeshi KOMIYA
fe89a07a92
Fix typo in doc/usage/configuration.rst
Co-authored-by: François Freitag <mail@franek.fr>
2021-05-31 02:54:17 +09:00
Takeshi KOMIYA
c97e9b14c4 Update docs 2021-05-20 23:43:34 +09:00
Takeshi KOMIYA
ce9e2e6c74 Rename linkcheck_ignore_redirects to linkcheck_allowed_redirects 2021-05-20 23:26:16 +09:00
Takeshi KOMIYA
4d061f2b49 Fix #9252: doc: Update explanation of highlight_language 2021-05-20 02:07:01 +09:00
igo95862
0f4039ab56
doc: Fixed opensearch.org link and upgraded to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
82f37344b0
doc: Upgraded dublincore.org link to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
cb004cc046
doc: Upgrade example.com links to HTTPS 2021-05-17 20:39:14 +03:00
igo95862
29aaf20a11
doc: Upgraded some of sphinx-doc.org links to HTTPS
Seems like that link is used in some tests and code so
upgrading it outside documentation might break something
2021-05-16 16:37:36 +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
630e5bd15f manpage: Stop creating a section directory on build manpage by default 2021-05-16 17:06:58 +09:00
Takeshi KOMIYA
8d87dde43b
Merge pull request #9232 from tk0miya/9217_dont_make_section_directory
manpage: Stop creating a section directory on build manpage by default
2021-05-16 17:02:41 +09:00
Takeshi KOMIYA
707319aab2 Close #6525: linkcheck: Add linkcheck_ignore_redirects
Add a new confval; linkcheck_ignore_redirects to ignore hyperlinks
that are redirected as expected.
2021-05-16 02:48:03 +09:00