Commit Graph

176 Commits

Author SHA1 Message Date
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
Takeshi KOMIYA
05eb2ca06f Close #6525: linkcheck: Add linkcheck_warn_redirects
Add a new confval; `linkcheck_warn_redirects` to emit a warning when
the hyperlink is redirected.  It's useful to detect unexpected redirects
under the warn-is-error mode.
2021-05-16 02:29:03 +09:00
Takeshi KOMIYA
fa8117cd2f manpage: Stop creating a section directory on build manpage by default 2021-05-15 22:23:40 +09:00
Takeshi KOMIYA
ac51fe8d2a doc: Update CHANGES and docs for PR #9176 2021-05-09 02:13:15 +09:00
ruro
104d0a3f69
describe nitpick_ignore_regex in docs 2021-05-02 13:31:13 +03:00
Takeshi KOMIYA
aeb00d8186 doc: Fix typo 2021-04-20 01:13:48 +09:00
Takeshi KOMIYA
930a880294 Fix #7199: py domain: Add a new confval: python_use_unqualified_type_names
Add a new config variable: python_use_unqualified_type_names.  If enabled,
it goes to suppress the module name of the python reference if it can be
resolved.
2021-03-06 14:00:00 +09:00
Takeshi KOMIYA
3059a999b2 Close #8326: Rename master_doc to root_doc
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`.  The old name is still available.  But it is recommeneded
to use new one from now on.
2021-02-28 17:10:57 +09:00
jfbu
fbafb308b8 Merge branch '3.x' into master_with_merged_3.x 2021-02-02 18:01:55 +01:00
Takeshi KOMIYA
ffe8fbf271 doc: Update doc for project_copyright (refs: #8783) 2021-01-30 11:38:16 +09:00
Takeshi KOMIYA
84dc65ad51 html: html_codeblock_linenos_style defaults to 'inline' (refs: #7849)
As discussed in #7879, the default style of line numbers for code
blocks in HTML output becames 'inline' by default.  And 'table' style
is now deprecated and will be removed in Sphinx-6.0.
2021-01-26 01:42:17 +09:00
Takeshi KOMIYA
0ad32905bf Merge branch '3.x' 2021-01-24 16:39:43 +09:00
Takeshi KOMIYA
41ee2d6e65
Merge pull request #8738 from tk0miya/8118_today_fmt
Fix #8118: doc: the default setting of today_fmt
2021-01-24 14:42:20 +09:00
Takeshi KOMIYA
0e6a2a9ebd
Merge pull request #8737 from tk0miya/8510_html_logo_url
Allow user to use url to reference html logo & favicon
2021-01-24 14:40:56 +09:00
Takeshi KOMIYA
502c4ee5fb Merge branch '3.x' 2021-01-24 14:32:13 +09:00
Takeshi KOMIYA
15cbc6dbb0 Close #6550: html: Allow to use HTML permalink texts
Add new configuration variables: `html_permalinks` and
`html_permalinks_icon`.

This refines the settings around HTML permalinks.

* html_add_permalinks
  * Deprecated.
* html_permalinks
  * Enable or disable permalinks feature.
* html_permalinks_icon
  * Change the icon for permalinks
2021-01-24 14:17:07 +09:00
Takeshi KOMIYA
41924776c4 Fix #8118: doc: the default setting of today_fmt
Sphinx has used `'%b %d, %Y'` as a default setting of today_fmt longer.
So this fixes our document as Sphinx does.
2021-01-23 22:11:33 +09:00
Takeshi KOMIYA
7cfcd81b76 doc: html_favicon and html_logo accept URL now 2021-01-23 20:49:15 +09:00
Takeshi KOMIYA
30f8640bab Merge branch '3.x' 2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
f81310708b
Merge pull request #8678 from tk0miya/doc_html_baseurl
Fix #8677: doc: Update description of html_baseurl
2021-01-14 01:10:12 +09:00
Takeshi KOMIYA
32ac5f2e57 Close #207: Now highlight_language supports multiple languages
This changes the structure of `highlight_options` to a dictionary that
maps language names to option dictionary.  It allows to setting pygments
options for multiple languages at once.
2021-01-11 21:40:09 +09:00
Takeshi KOMIYA
5d07135a1e Fix #8677: doc: Update description of html_baseurl 2021-01-11 19:45:55 +09:00
Takeshi KOMIYA
5460ea103b Merge branch '3.x' 2021-01-08 01:23:17 +09:00
Takeshi KOMIYA
e9a4ebf70d doc: Add explanation for the priority attribute of html_*_files 2021-01-03 00:16:10 +09:00
Takeshi KOMIYA
a122397b4b Merge branch '3.x' 2020-12-29 18:37:45 +09:00
Takeshi KOMIYA
c7d1536828 Close #8132: Add project_copyright confval as an alias of copyright
Avoid to pylint error, add a new config variable; project_copyright
as an alias of `copyright`.
2020-12-27 18:40:06 +09:00
Takeshi KOMIYA
2c98e909bf Merge branch '3.x' 2020-12-14 02:02:29 +09:00
Takeshi KOMIYA
1d9eeedde3 Fix #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese
Since v2.3, Sphinx supports uplatex as an alternative of latex_engine for Japanese
docs (refs: #4186, #6841). uplatex is able to build a document without conversion
character encoding internally. It allows using unicode characters in documents.
Additionally, uplatex is compatible with platex (current default latex_engine for
Japanese docs).

This changes the default latex_engine for Japanese document to uplatex.
2020-11-29 15:09:49 +09:00
François Freitag
6b90a63f08 Fix #6629: linkcheck: Handle rate-limiting
Follow the Retry-After header if present, otherwise use an exponential
back-off.
2020-11-25 17:34:55 +01:00
Takeshi KOMIYA
7eabbfc5ec
Merge pull request #8284 from tk0miya/7996_man_make_section_directory_by_default
Close #7996: manpage: Make a section directory on build manpage by default
2020-10-28 11:03:13 +09:00
Takeshi KOMIYA
c40b4249cd Merge branch '3.x' into master 2020-10-28 02:23:36 +09:00
Takeshi KOMIYA
a843fd3db8 Close #7996: manpage: Make a section directory on build manpage by default 2020-10-28 02:15:36 +09:00