IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
19,877 Commits 2 Branches 219 Tags 163 MiB
6845c3fd96
Commit Graph

233 Commits

Author SHA1 Message Date
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
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
Thomas Grainger
3f26564c28
Apply suggestions from code review 2020-10-05 22:10:25 +01:00
Thomas Grainger
3eecf133d8
Fix #8289: Allow to suppress "duplicated ToC entry found" warnings from epub builder 2020-10-05 09:29:16 +01:00
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +09:00
Takeshi KOMIYA
178c05b059 Close #7996: manpage: Add man_make_section_directory 
Add a new config variable; man_make_section_directory to make a
section directory on build man page.  During 3.x, it defaults to
False and will be changed to True on 4.0 release.
 2020-10-03 22:30:20 +09:00
Takeshi KOMIYA
8412347f5d Merge branch '3.x' 2020-08-14 14:28:58 +09:00
Takeshi KOMIYA
a8927bcd3e Merge branch '3.x' 2020-08-08 18:16:59 +09:00
Michal Čihař
1bf7fe424e i18n: Add support for having single text domain 
The gettext_compact can now be a string which is then a single domain
for all documents.

Fixes #784
 2020-08-07 20:22:30 +02:00
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
af15593c0c Close #7768: i18n: figure_language_filename supports {docpath} token 
To build structured i18n imaging directory, figure_language_filename
now supports `{docpath}` token that is a dirname of the current
document.
 2020-08-02 16:28:54 +09:00
Takeshi KOMIYA
327c187284 Merge branch '3.x' 2020-07-24 23:49:45 +09:00
Takeshi KOMIYA
897be0ebae Close #7784: i18n: The alt text for image is translated by default 
Make alt text for image translatable by default without settings of
gettext_additional_targets.
 2020-07-19 12:58:28 +09:00
Jakob Lykke Andersen
18b00d8cff Add docs and CHANGES for C changes 2020-07-14 11:48:58 +02:00
Takeshi KOMIYA
70d521ad9c Merge branch '3.x' 2020-07-11 21:59:58 +09:00
Takeshi KOMIYA
6dfbc5108e Close #7849: html: Add html_codeblock_linenos_style 2020-07-11 20:59:38 +09:00
Takeshi KOMIYA
1a223209f2 Merge branch '3.x' 2020-07-05 19:56:21 +09:00
Takeshi KOMIYA
ec3754bd94 Merge branch '3.x' 2020-07-05 01:32:54 +09:00
Takeshi KOMIYA
44f4b2ad97 Merge tag 'v3.1.0' 2020-07-05 00:10:47 +09:00
Takeshi KOMIYA
0c24baaa0c doc: Update docs (refs: #7907) 2020-07-04 11:56:45 +09:00
Tim Metzler
5ba5cb60e3
Use double backticks for filename example 2020-07-03 19:08:53 +02:00
Tim Metzler
3982d526b2
Shorten line to less than 85 characters 2020-07-03 14:27:14 +02:00
Tim Metzler
9dcd88709c
Clarify language specific figures format 
I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading. 
I replaced the underscores by periods and added a small example.
 2020-07-03 14:11:53 +02:00
Takeshi KOMIYA
068b9b5738 Merge branch '3.x' 2020-06-04 00:18:30 +09:00
Takeshi KOMIYA
a7725ad8ca Close #7247: linkcheck: Add linkcheck_request_headers 2020-06-01 01:48:46 +09:00
Kai Welke
0ee57a6f6e
Fixed broken link to pygments lexers doc 2020-05-26 09:35:47 +02:00
Takeshi KOMIYA
3c7d35d2a2 Merge branch '3.x' 2020-05-17 19:12:56 +09:00
Takeshi KOMIYA
b1554ae25a doc: Fix wrong version info 2020-05-10 01:12:39 +09:00
Takeshi KOMIYA
42aa293679 Merge branch '3.x' 2020-04-27 00:54:23 +09:00
Takeshi KOMIYA
05aff200b1 LaTeX: Add :confval:latex_theme_options to override theme options 2020-04-20 00:51:08 +09:00
Takeshi KOMIYA
1aca70cf80 Merge branch '3.x' 2020-04-13 23:36:49 +09:00
Takeshi KOMIYA
b2a601a33d Merge branch '3.0.x' into 3.x 2020-04-13 23:36:10 +09:00
Jakob Lykke Andersen
d4058eb67f C, parse attributes 2020-04-13 13:43:26 +02:00
Tetsuo Koyama
4983a12f21
➕ 🇧🇬 🇮🇳 🇦🇱 🇷🇸 2020-04-12 19:04:42 +09:00
Takeshi KOMIYA
10d7760156 Fix #7410: Allow to suppress "circular toctree references detected" warnings 2020-04-12 15:25:35 +09:00
Takeshi KOMIYA
c7e590818a Merge branch '3.x' 2020-03-21 17:53:22 +09:00
Jakob Lykke Andersen
f12a7f1ae2 Simplify backslash stripping 2020-03-20 13:26:45 +01:00
Jakob Lykke Andersen
e0f779ba3d Remove backslash stripping in domains. 
Adds several ways to reinstate the old behaviour.

Fixes sphinx-doc/sphinx#6462
 2020-03-20 12:25:31 +01:00
Takeshi KOMIYA
3e0618ba3a Deprecate codes for docutils-0.13 or 0.14 2020-03-07 19:36:41 +09:00
Takeshi KOMIYA
cdbefb600f Support user defined LaTeX themes 2020-03-06 22:11:25 +09:00
Takeshi KOMIYA
a033d53c24 Close #7032: html_scaled_image_link is disabled for individual image 2020-02-18 01:48:11 +09:00
Takeshi KOMIYA
0c0d037059
Merge pull request #7083 from tk0miya/update_docs 
doc: Make desc of gettext_additional_targets easy to read
 2020-02-01 13:39:21 +09:00
Takeshi KOMIYA
423a7a7131 doc: Make desc of gettext_additional_targets easy to read 2020-02-01 13:12:32 +09:00
Takeshi KOMIYA
15c266c445 Merge branch '2.0' 2019-11-30 21:52:42 +09:00
Takeshi KOMIYA
9bd64e4e2a
Merge pull request #6862 from tk0miya/6854_update_supported_languages_list 
Update supported languages (refs: #6854)
 2019-11-27 00:04:22 +09:00