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
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
fddc42847f
Fix #2030 : automatic dedent support in code-block directive
2021-01-13 01:10:28 +09:00
François Freitag
5166dd194c
Strip trailing whitespaces and normalize line endings
...
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.
Update a handful of files to use the UNIX line ending.
2020-10-03 13:47:01 +02:00
Jakob Lykke Andersen
500f45fd4c
C, recursive alias declarations
...
Fixes sphinx-doc/sphinx#8141
2020-09-13 16:37:53 +02:00
Chris Mayo
fe4a158caf
Fix typos in the documentation
2020-08-03 19:30:38 +01:00
Chris Holdgraf
84f7dffd99
comments
2020-07-29 10:38:18 +01:00
Chris Holdgraf
60b105d6aa
several documentation improvements to theming, templating, and extension development
2020-07-29 10:38:18 +01:00
Yoshiki Shibukawa
70aa913bb2
fix 6863: add description literalinclude option (start/end have same string)
2020-07-25 22:36:06 +09:00
Jakob Lykke Andersen
c668500a4b
Add :noindexentry: option
...
Fixes sphinx-doc/sphinx#7052
2020-07-04 19:34:00 +02:00
Jakob Lykke Andersen
8c82ecbf2c
Merge pull request #7895 from jakobandersen/c_cpp_noindex
...
C, C++: remove noindex option
2020-07-02 15:38:45 +02:00
Jakob Lykke Andersen
ff5eb7cc2b
C, C++: remove noindex option
...
The option did nothing.
Improve error messages on duplicates.
2020-06-30 13:52:18 +02:00
Jakob Lykke Andersen
7cbf54c210
C, add c:alias directive
2020-06-30 11:20:17 +02:00
Stefano David
f4cb82cd84
documentation for proper code-block cross-referencing
2020-06-07 18:06:51 +02:00
Michaël Defferrard
5e5bd748e6
remove repeted word in reStructuredText Primer
2020-05-20 22:30:58 +02:00
Takeshi KOMIYA
87308d9607
Close #7143 : py domain: Add :final: option to py:*: directives
2020-04-28 01:24:29 +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
Jakob Lykke Andersen
bbc7b6cc54
C, add scoping directives
2020-04-12 14:13:54 +02:00
Takeshi KOMIYA
ab75982be0
Fix document
2020-03-22 17:49:17 +09:00
Takeshi KOMIYA
eccb9abe4a
doc: Update about toctree directive
2020-03-21 16:37:34 +09:00
Jakob Lykke Andersen
b2ca906830
C, add expression parsing and expr role
2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen
815a9c657d
C, add new directives, fix xref lookup
2020-03-15 19:49:16 +01:00
Jakob Lykke Andersen
0f49e30c51
C, initial rewrite
2020-03-15 19:49:16 +01:00
Takeshi KOMIYA
73e99ab88b
Update CHANGES and docs for PR #7064
2020-03-05 20:40:35 +09:00
Takeshi KOMIYA
bfce1a71f6
Merge pull request #7087 from geographika/named-index-links
...
Add name option for the index directive
2020-02-23 12:27:57 +09:00
sethg
b20d74f8a0
Review updates
2020-02-22 13:31:18 +01:00
Takeshi KOMIYA
30b0361f9c
Close #7025 : html search: full text search can be disabled via metadata
2020-02-22 17:34:44 +09:00
sethg
28ad370343
Add option to docs
2020-02-16 21:37:41 +01:00
Takeshi KOMIYA
2e87ee85a2
Merge branch '2.0'
2020-02-09 00:57:53 +09:00
Takeshi KOMIYA
f6acd061f3
docs: Add a restriction note about tocdepth (refs: #6033 )
2020-02-07 23:59:20 +09:00
Takeshi KOMIYA
179a1f9cc2
py domain: Support type annotations for variables
...
This adds ``:type:`` and ``:value:`` options to both ``py:data``
and ``py:attribute`` directives. It allows to describe its
annotation in detail.
2020-02-01 12:58:27 +09:00
Jakob Lykke Andersen
9fa23615ec
Fixes from review
2020-01-25 17:02:59 +01:00
Jakob Lykke Andersen
c084c3f124
Implement scoping for productionlist
...
Fixes sphinx-doc/sphinx#3077
2020-01-22 22:32:30 +01:00
Takeshi KOMIYA
f169560395
Merge pull request #6979 from tk0miya/6830_autodoc_private
...
Close #6830 : autodoc: consider a member private if docstring contains :private:
2020-01-11 15:14:52 +09:00
Takeshi KOMIYA
cad1f86dd8
Merge branch '2.0'
2020-01-11 02:56:58 +09:00
Ralf Gommers
659c66ad98
Update documentation of download role for addition of hash in subdir
...
This was changed in gh-5377, but that forget the (now slightly
misleading) documentation.
Discovered in https://github.com/numpy/numpy.org/pull/14 , where
we were relying on download links being stable.
2020-01-07 13:06:16 +01:00
Takeshi KOMIYA
b968bb91e9
Close #6830 : autodoc: consider a member private if docstring has "private" metadata
2020-01-04 13:28:07 +09:00
Takeshi KOMIYA
712c20a3d9
Merge branch '2.0'
2019-12-16 00:05:35 +09:00
Damien Ayers
1a54a7229c
Fix documentation typo
...
(cherry picked from commit 937c684960
2019-12-13 23:27:04 +01:00
Damien Ayers
937c684960
Fix documentation typo
2019-12-13 12:33:02 +11:00
jfbu
2199a127e8
Typo (refs #6491 )
2019-12-09 22:57:45 +01:00
Takeshi KOMIYA
7ec567b6d0
Merge branch '2.0'
2019-12-09 00:13:42 +09:00
Takeshi KOMIYA
9e40f2a603
doc: rewrite options for code-block by directive:option directive
2019-12-08 21:33:06 +09:00
Takeshi KOMIYA
d82e0bb5a5
doc: rewrite options for highlight by directive:option directive
2019-12-08 21:33:06 +09:00
jfbu
dc53404d48
Fix markup issue in our docs
2019-11-26 14:22:17 +01:00
jfbu
d398959230
Fix typo in docs
2019-11-26 14:11:40 +01:00
Joe
1fd7176f89
Fix link to pygments lexer
2019-11-16 18:11:14 -08:00
Timotheus Kampik
0662a3ecd6
#6503 document meta directive ( #6562 )
...
#6503 document meta directive
The `meta` directive has partly Sphinx-specific behavior
and hence needs to be documented
2019-07-08 22:48:41 +02:00
