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
Nicolas Delon
bf588c42b2
Fix typo in autodoc documentation
2021-08-25 23:42:27 +02: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
Juan Luis Cano Rodríguez
a606db01f1
Add section on autosummary
2021-08-12 20:09:50 +02:00
Juan Luis Cano Rodríguez
2c1fa831c1
Add tutorial section on documenting Python objects
2021-08-12 20:06:56 +02:00
Takeshi KOMIYA
2138c296c6
Merge branch '4.x'
2021-08-13 01:39:42 +09:00
John Cole
8dbef8798a
Fix typo
2021-08-04 20:28:45 -04:00
Takeshi KOMIYA
b9a4a5d06f
Merge branch '4.x'
2021-07-30 02:20:24 +09:00
Darren Ng
8ea5587ed9
:manpage: is a role, not a directive. [ci skip]
2021-07-26 16:33:18 +08:00
Takeshi KOMIYA
6e87c17a76
doc: Add document for autoproperty directive (refs: #9486 )
2021-07-23 23:10:48 +09:00
Takeshi KOMIYA
779274d4b8
Merge branch '4.x'
2021-07-23 02:17:12 +09:00
Takeshi KOMIYA
120525563c
Cloase #9445 : :py:property: directive now supports :classmethod: option
...
Since python 3.9, `classmethod` starts to support creating a "class
property". This allows to describe it.
2021-07-17 14:24:31 +09:00
Takeshi KOMIYA
dd00bade70
Merge branch '4.x'
2021-07-12 02:15:45 +09:00
Juan Luis Cano Rodríguez
8531f20eb7
Fix link to NumPy Docstring Standard
2021-07-08 22:34:25 +02:00
Eisuke Kawashima
652ebf1bf5
Fix typo
2021-07-08 08:16:22 +09:00
Takeshi KOMIYA
5e5bca98f7
Merge branch '4.x' into 6525_linkcheck_warn_redirects
2021-07-07 02:09:50 +09:00
Takeshi KOMIYA
5ce5f40402
Merge pull request #9340 from ocket8888/patch-1
...
Update example to use recommended usage
2021-07-07 01:50:34 +09:00
Juan Luis Cano Rodríguez
b9da1577b6
Merge branch '4.x' into new-tutorial-part-ii
2021-07-05 20:12:53 +02:00
Juan Luis Cano Rodríguez
6f9bc6e7e5
Use "builtin" for extensions label as it is done for themes
2021-07-05 09:32:10 +02:00
Juan Luis Cano Rodríguez
f303a4a9ed
Consistent use of "rst" for syntax highlight
2021-07-05 09:25:05 +02:00
Juan Luis Cano Rodríguez
50bd1c3967
Remove unnecessary label
2021-07-05 09:22:14 +02:00
Takeshi KOMIYA
0ee0d8df00
Merge pull request #9399 from tk0miya/napoleon_preprocess_types
...
doc: Fix the default value of napoleon_preprocess_types is True
2021-07-04 11:26:43 +09:00
Takeshi KOMIYA
e8ba4f1803
Merge pull request #9392 from LouisJustinTALLOT/patch-1
...
Fix quotes in docstring in ext.napoleon
2021-07-03 20:10:55 +09:00
Takeshi KOMIYA
f6b3f36e23
doc: Fix the default value of napoleon_preprocess_types is True
2021-07-03 17:41:57 +09:00
Louis-Justin TALLOT
a52ccdbfc7
Fix quotes in docstring in ext.napoleon
2021-06-30 19:40:35 +02:00
Takeshi KOMIYA
ec351bdf3d
Merge branch '4.0.x' into 4.x
2021-06-30 21:24:06 +09:00
Juan Luis Cano Rodríguez
c9d2a73d93
Rename to root document
2021-06-22 15:27:54 +02:00
Juan Luis Cano Rodríguez
3fcaa172db
Move reference to list of Pygments lexers
2021-06-21 07:38:51 +02: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
Juan Luis Cano Rodríguez
57b0a1b465
Add section about the toctree
2021-06-17 00:31:53 +02:00
Juan Luis Cano Rodríguez
1e49218993
Add tutorial section about extensions and themes
2021-06-17 00:21:42 +02:00
ocket8888
9db8775ba7
Update example to use recommended usage
2021-06-14 11:21:28 -06:00
Juan Luis Cano Rodríguez
1ffbfa72f1
Merge branch '4.x' into new-tutorial
2021-06-06 10:49:07 +02:00
Takeshi KOMIYA
e0500f7354
doc: Fix docslint misunderstanding scope of code-blocks
2021-06-06 13:24:06 +09:00
Juan Luis Cano Rodríguez
565713d228
Change Pygments lexer to account for prompt
2021-05-31 18:03:04 +02:00
Juan Luis Cano Rodríguez
1da5ab5808
Style fixes
...
Co-authored-by: Steve Piercy <web@stevepiercy.com>
2021-05-31 16:26:21 +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
Juan Luis Cano Rodríguez
bfca913f16
Move virtual environment explanation to installation
2021-05-29 19:15:15 +02:00
Grey Li
6a0dae08d0
Fix typo in doc/intl.rst
...
The pot files are in the gettext folder instead of locale folder.
2021-05-27 17:28:10 +08: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
Takeshi KOMIYA
549f09e048
Merge pull request #9239 from igo95862/https-links
...
Upgrade URLs to use HTTPS
2021-05-19 22:59:19 +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
3f0a840c54
doc: Upgraded plantuml.org link to HTTPS
2021-05-17 20:39:14 +03:00
igo95862
b6c2edb5ca
doc: Upgraded mathjax documentation link to HTTPS
2021-05-17 20:39:14 +03:00
igo95862
bb173a5789
doc: Moved flask links to new home and HTTPS
...
Seems like Flask is no longer pocoo project but
palletsprojects.com
2021-05-17 20:39:13 +03:00
igo95862
cfa449624d
doc: Moved Jinja links to new home page and HTTPS
...
Seems like Jinja is no longer pocoo project but
palletsprojects.com
2021-05-17 20:38:48 +03:00
Takeshi KOMIYA
bc7087a1a2
Merge branch '4.x' into 3014_autodoc-process-bases
2021-05-17 22:40:27 +09: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
6c5f77c689
doc: Upgrade pygments.org links to HTTPS
2021-05-16 15:53:58 +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
igo95862
28b9475019
doc: Upgrade writethedocs.org domain link to HTTPS
2021-05-16 15:08:18 +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
51ae283a38
Close #4257 : autodoc: Add autodoc_class_signature
...
Add `autodoc_class_signature` to separate the class entry and the
definition of `__init__()` method.
2021-05-16 01:53:48 +09:00
Takeshi KOMIYA
67db20d705
Close #3014 : autodoc: Add autodoc-process-bases
...
Add `autodoc-process-bases` to modify the base classes of the class
definitions. This allows the extensions to insert or modify the list
of the base classes via event-handlers.
2021-05-16 00:46:06 +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
c341807991
Merge pull request #9185 from AWhetter/autodoc_typehints_both
...
autodoc.typehints can accurately represent overloads
2021-05-12 00:23:58 +09:00
Takeshi KOMIYA
0b0414ea17
Update "versionadded" in doc/usage/extensions/autodoc.rst
2021-05-12 00:04:43 +09:00
Ashley Whetter
28d3f8136e
autodoc.typehints can accurately represent overloads
2021-05-08 21:34:25 -07:00
Takeshi KOMIYA
ac51fe8d2a
doc: Update CHANGES and docs for PR #9176
2021-05-09 02:13:15 +09:00
Takeshi KOMIYA
d82c8a7890
Merge pull request #9131 from RuRo/feature/glob-nitpick-ignore
...
Ignore nitpick warnings with regular expressions using `nitpick_ignore_regex`
2021-05-05 23:43:46 +09:00
ruro
104d0a3f69
describe nitpick_ignore_regex in docs
2021-05-02 13:31:13 +03:00
Takeshi KOMIYA
d8a9f243e2
Close #8107 : autodoc: Add class-doc-from option to autoclass directive
...
Add `class-doc-from` option to the `autoclass` directive to control
the content of the specific class. It takes `class`, `init`, and `both`
like `autoclass_content`.
2021-05-01 14:53:06 +09:00
Takeshi KOMIYA
d8fa067583
Add doc and testcase for program directive (refs: #9137 )
...
There is no docs and testcases for "None" argument of the program
directive. It has been implemented since very old version. But it's
not documented and tested long.
2021-04-28 02:16:57 +09:00
Matthias Geier
778faffecc
Add documentation for mathjax2_config and mathjax3_config
2021-04-24 18:30:44 +09:00
Matthias Geier
7b9cc0563d
Add documentation for mathjax2_config and mathjax3_config
2021-04-24 10:50:37 +02:00
Takeshi KOMIYA
53dff4ef5f
Merge branch '4.0.x' into 4.x
2021-04-20 01:45:12 +09:00
Takeshi KOMIYA
aeb00d8186
doc: Fix typo
2021-04-20 01:13:48 +09:00
Takeshi KOMIYA
668bc9eec9
Merge branch '4.0.x' into 4.x
2021-04-19 01:08:54 +09:00
Harmon
31718d78b4
doc: Fix grammar in documentation for autodoc_typehints
2021-04-17 17:46:31 +02:00
Juan Luis Cano Rodríguez
130ed4bb4a
Recommend MyST-Parser for Markdown usage
2021-04-15 20:31:13 +02:00
Harmon
5af55008b3
doc: Fix grammar in documentation for autodoc_typehints
2021-04-14 16:41:25 -05:00
Takeshi KOMIYA
32337c3ba7
Merge pull request #9084 from tk0miya/8731_docs_for_napoleon_preprocess_types
...
doc: Add docs for napoleon_preprocess_types
2021-04-13 01:15:44 +09:00
Takeshi KOMIYA
d59e96c8b4
docs: Add versionchanged tag to extlinks (refs: #8898 )
2021-04-11 22:25:48 +09:00
Merry Bass
75605d437f
fixup! sphinx.ext.extlinks: Clarify escaping of `%
`
2021-04-11 22:14:24 +09:00
Merry Bass
ef1747f03a
sphinx.ext.extlinks: Clarify escaping of `%
`
...
We use Pythons %-formatting, so literal ``%`` must be escaped as ``%%``.
Clarify this behaviour for the caption and base URL strings.
2021-04-11 22:14:17 +09:00
Merry Bass
fb39974486
sphinx.ext.extlinks: Allow `%s
` in link caption string
...
Tweak syntax of extlinks to also allow ``%s`` in the link caption part.
Like for the base URL ``%s`` will be substituted with the content of the
role. This allows configurations like
extlinks = {'quarter': ('https://example.org/quaters/%s ',
'%s. quarter')}
with ``:quarter:`2``` getting replaced by a link titled `2. quarter`.
The requirement for the caption string is to be either None or contain
exactly one ``%s``. If neither is the case, then we emit a warning and
fall back to the old behaviour which is concatenating the caption string
with the role content.
2021-04-11 22:14:01 +09:00
Takeshi KOMIYA
d09747f225
doc: Add docs for napoleon_preprocess_types
2021-04-11 21:35:47 +09:00
Takeshi KOMIYA
70ea4381ca
Merge pull request #8841 from AWhetter/autodoc_signatures_without_backslash
...
Overloaded function signatures do not require a separating backslash
2021-04-04 18:02:01 +09:00
Takeshi KOMIYA
41a377fee5
Merge branch '3.x'
2021-04-04 00:06:45 +09:00
Albert Villanova del Moral
260725c823
Fix minor typo
2021-03-30 08:45:34 +02:00
Matt Wozniski
4785f32ddf
Add autodoc_typehint_undoc option
...
Previously, if autodoc_typehints="description", a :type: field would be
added for every parameter and return type appearing in the annotation,
including **kwargs and underscore-prefixed parameters that are meant to
be private, as well as None return types.
This commit introduces a new option, "autodoc_typehint_undoc". By
default this option is True, requesting the old behavior. By setting
this option to False, :type: and :rtype: fields will only be added for
annotated parameters or return types if there is already a corresponding
:param: or :return: field, to put users in control over whether a given
parameter is documented or not.
2021-03-27 14:54:37 -04:00
Ashley Whetter
94b5607591
Overloaded function signatures do not require a separating backslash
2021-03-27 10:25:20 -07:00
Takeshi KOMIYA
45f56dd7ac
Fix #9008 : Fix typo
2021-03-16 01:28:07 +09:00
Takeshi KOMIYA
17bb78997c
Merge pull request #7298 from tk0miya/7068_pyproperty_directive
...
py domain: Add py:property directive to describe a property (refs: #7068 )
2021-03-13 21:22:29 +09:00
Takeshi KOMIYA
204f86f736
py domain: Add py:property directive to describe a property (refs: #7068 )
2021-03-11 01:56:39 +09:00
Takeshi KOMIYA
54886fd256
Close #7549 : autosummary: Enable autosummary_generate by default
2021-03-10 01:35:49 +09:00
Takeshi KOMIYA
ae413e95ed
Merge pull request #8970 from naveen521kk/patch-1
...
Sphinx is available on Chocolatey
2021-03-07 21:30:46 +09:00
Naveen M K
1b425230e3
lint
2021-03-07 00:21:41 +05:30
Naveen M K
2638e9aecc
Sphinx is available on Chocolatey
2021-03-07 00:13:40 +05:30
Takeshi KOMIYA
0dcdbdc230
doc: Fix indentation
2021-03-06 21:19:26 +09:00
Takeshi KOMIYA
008feac9ad
Merge pull request #8965 from tk0miya/refactor_doc
...
doc: Update document for autodoc
2021-03-06 20:15:24 +09:00
Takeshi KOMIYA
697fdea612
doc: Update document for autodoc :special-members: option
2021-03-06 19:12:52 +09:00
Takeshi KOMIYA
8411b9a536
doc: Update document for autodoc :private-members: option
2021-03-06 19:12:47 +09:00
Takeshi KOMIYA
009fd4c396
doc: Update document for autodoc :undoc-members: option
2021-03-06 19:12:41 +09:00
Takeshi KOMIYA
f37e679fd1
doc: Update document for autodoc :members: option
2021-03-06 19:12:34 +09:00
Takeshi KOMIYA
1ea11b1e48
Fix #759 : autodoc: Add sphinx.ext.autodoc.preserve_defaults extension
...
Add a new extension `sphinx.ext.autodoc.preserve_defaults`.
It preserves the default argument values of function signatures in source code
and keep them not evaluated for readability. This is an experimental
extension and it will be integrated into autodoc core in Sphinx-4.0.
2021-03-06 18:48:18 +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
62401ef1ec
Merge branch '3.x'
2021-02-12 21:27:17 +01:00
Jakob Lykke Andersen
a7fcc15683
C++, add noroot option to alias directive
2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen
06a956200b
C, add noroot option to alias directive
2021-02-12 17:25:12 +01:00
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