Commit Graph

589 Commits

Author SHA1 Message Date
Jakob Lykke Andersen
d0a4d0147e C++, add recursiveness to alias
Fixes sphinx-doc/sphinx#8213 in the most basic way.
2021-02-12 17:25:12 +01:00
Harrissou Sant-anna
08c2c23bb4 Make code block types more visible 2021-02-08 13:03:16 +01:00
jfbu
87fa272763 Merge branch '3.x' into merge_3.x_into_master
Resolved Conflicts:
	sphinx/texinputs/sphinxpackagefootnote.sty
2021-02-04 16:31:45 +01:00
jfbu
fbafb308b8 Merge branch '3.x' into master_with_merged_3.x 2021-02-02 18:01:55 +01:00
pbudzyns
270921d73a Merge remote-tracking branch 'upstream/3.x' into exclude-members-fix 2021-02-01 10:46:44 +01:00
pbudzyns
35adeeff41 update docs 2021-02-01 10:28:01 +01:00
Takeshi KOMIYA
ffe8fbf271 doc: Update doc for project_copyright (refs: #8783) 2021-01-30 11:38:16 +09:00
Takeshi KOMIYA
c9480f9943 Merge branch '3.x' 2021-01-28 00:56:46 +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
34417831c5 doc: Add hyperlinks to classifiers for sphinx extensions and themes 2021-01-24 16:45:50 +09:00
Takeshi KOMIYA
0ad32905bf Merge branch '3.x' 2021-01-24 16:39:43 +09:00
Takeshi KOMIYA
51d500833e Merge branch '3.x' into 7774_remove_develop.rst 2021-01-24 16:34:47 +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
3100ceb220 doc: minor fix 2021-01-23 22:32:17 +09:00
Takeshi KOMIYA
f707cb30a1 Merge pull request #7798 from stefanodavid/code-block-crossref-doc
documentation for proper code-block cross-referencing
2021-01-23 22:31:02 +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
Steve Piercy
cef669cb0f Update the link to the new sphinx-contrib organization
This should be backported to at least 3.x, too.
2021-01-23 17:28:35 +09:00
Takeshi KOMIYA
37fc43a4d3 Merge pull request #8734 from stevepiercy/patch-2
Update the link to the new sphinx-contrib organization
2021-01-23 17:27:04 +09:00
jfbu
2e22bd0a23 Merge branch 'master' into latex_font_for_pdflatex 2021-01-23 09:13:08 +01:00
Steve Piercy
bd63ae9950 Update the link to the new sphinx-contrib organization
This should be backported to at least 3.x, too.
2021-01-23 00:08:57 -08:00
Takeshi KOMIYA
5ce72f465b Merge branch '3.x' 2021-01-22 22:52:32 +09:00
jfbu
99a8b7f37f LaTeX: update default font configuration
This replaces times package with tgtermes and tgheros (clones of Times and
Helvetica with better LaTeX support) and the monospace font from txfonts
package (txtt). This font is better matched with Times-like fonts than
Courier clones.

The changes applies to pdflatex/platex/uplatex.

Fixes: #8711
2021-01-20 23:03:08 +01:00
Guillaume Melquiond
8a1d0d0da6 Allow production lists to refer to tokens from other production groups.
Outside production lists, syntax "`foo:bar`" already makes it possible to
refer to the production "bar" of group "foo". This commit offers the same
feature inside production lists. Similarly to the reference syntax,
prefixing with a tilde prevents the group from being displayed.

This commit also makes it possible to use "`:bar`" to refer to production
"bar" from a production list without a group name. This is especially
useful when one has a main (unnamed) grammar and one or several named
extensions that need to refer to it.
2021-01-20 17:57:52 +01:00
Takeshi KOMIYA
ca0677086d Merge pull request #8658 from SolidifiedRay/feature-custom-section
Close #8573: napoleon: Add more custom section styles
2021-01-19 21:13:13 +09:00
SolidifiedRay
7ad85cd1e0 Close #8573: napoleon: Add more custom section styles 2021-01-18 11:43:40 -08:00
Takeshi KOMIYA
30f8640bab Merge branch '3.x' 2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
b742bde8e6 Merge pull request #8684 from tk0miya/2030_automatic_dedent
Fix #2030: automatic dedent support in code-block directive
2021-01-14 01:11:02 +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
fddc42847f Fix #2030: automatic dedent support in code-block directive 2021-01-13 01:10:28 +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
f433581b04 doc: Fix highlight language 2021-01-10 22:22:30 +09:00
Takeshi KOMIYA
5460ea103b Merge branch '3.x' 2021-01-08 01:23:17 +09:00
Takeshi KOMIYA
a9c7dd7037 Merge branch '3.x' 2021-01-03 00:20:27 +09:00
Takeshi KOMIYA
e9a4ebf70d doc: Add explanation for the priority attribute of html_*_files 2021-01-03 00:16:10 +09:00
Hong Xu
1f020196a7 DOC: modules are only available when recursive is on
See
7ecf6b88aa/sphinx/ext/autosummary/generate.py (L314-L315)
2021-01-01 11:12:58 -08:00
Takeshi KOMIYA
a122397b4b Merge branch '3.x' 2020-12-29 18:37:45 +09:00
Takeshi KOMIYA
150f788e0e Merge pull request #8600 from tk0miya/8132_project_copyright
Close #8132: Add project_copyright confval as an alias of copyright
2020-12-28 17:26:49 +09:00
Hong Xu
d9ca895dbb Update autodoc.rst 2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1 Doc: Correct type: "TypeAlias" -> "AliasType" 2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
c5a9d04d45 Merge branch '3.x' into 8132_project_copyright 2020-12-28 13:56:11 +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
9e9e486e65 Close #8022: autodoc: Allow to hide the value of the variables via metadata
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
2c98e909bf Merge branch '3.x' 2020-12-14 02:02:29 +09:00
Ned Batchelder
bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05: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