Commit Graph

44 Commits

Author SHA1 Message Date
igo95862
6c5f77c689
doc: Upgrade pygments.org links to HTTPS 2021-05-16 15:53:58 +03: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
Harrissou Sant-anna
08c2c23bb4
Make code block types more visible 2021-02-08 13:03:16 +01: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
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
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Yoshiki Shibukawa
70aa913bb2 fix 6863: add description literalinclude option (start/end have same string) 2020-07-25 22:36:06 +09:00
Stefano David
f4cb82cd84 documentation for proper code-block cross-referencing 2020-06-07 18:06:51 +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
sethg
b20d74f8a0 Review updates 2020-02-22 13:31:18 +01:00
sethg
28ad370343 Add option to docs 2020-02-16 21:37:41 +01: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
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
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
Takeshi KOMIYA
54d5fcfaeb
Merge pull request #6416 from tk0miya/2310_force_highlighting
Add :force: option to code directives
2019-06-01 14:17:53 +09:00
Takeshi KOMIYA
e001d358d0 Add :force: option to code directives 2019-06-01 13:42:57 +09:00
Takeshi KOMIYA
c6d840d95a doc: Change wording for contents directive (refs: #6265) 2019-06-01 11:27:38 +09:00
Takeshi KOMIYA
9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
6ca669295c Close #1851: Allow to omit an argument for code-block directive 2019-02-04 01:50:44 +09:00
Takeshi KOMIYA
e0e3ba4d91 doc: Fix indentation 2019-02-04 01:31:30 +09:00
jfbu
32d57b8637 Merge branch '1.8'
resolved Conflicts:
	doc/development/tutorials/todo.rst
	sphinx/locale/__init__.py
	sphinx/search/zh.py
2018-12-28 12:50:20 +01:00
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
jfbu
fdb6147555 LaTeX (doc): explain how to allow Unicode input in math
Closes: #5249
2018-12-20 19:43:50 +01:00
Takeshi KOMIYA
e045dacc84 doc: Move description for math confval, directives and roles to usage 2018-07-28 18:43:02 +09:00
Jon Dufresne
2f17a0e8c8 Update Python 2 doc links to Python 3
Python 3 docs are more actively maintained and are the future.
2018-06-09 20:59:43 -07:00
Nicholas Devenish
5685512e6a Add missing literalinclude options documentation
The start-at and end-at options, added in 560b572 for v1.5a1, #625
weren't previously documented. This fixes that.
2018-04-11 18:10:37 +01:00
Stephen Finucane
2565195a44 doc: Add "domains" doc to usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
893a7ac1f2 doc: Rework "showing code" section
This makes the section more consistent with the rest of the document.
This adds a new section to the basics guide for doctest blocks, which
are a docutils thing. It also update the default highlight language,
which is now 'default'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
ecd193cde8 doc: Extend "directives" doc, part 3
Finish building up this combined doc by adding the contents of the
former 'misc' document. There are no changes to the content.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
e01e9e34bb doc: Extend "directives" doc, part 2
Continue building up this combined doc by adding the contents of the
former 'code' document. There are no changes to the content.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
0641209da9 doc: Extend "directives" doc, part 1
Continue building up this combined doc by adding the contents of the
former 'para' document. There are no changes to the content.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
fdf91e502c doc: Add "directives" doc to restructuredtext section
There's simply no need to artificially divide up the documentation on
directives into multiple, hard-to-navigate documents. Gather all
documentation for directives into one easy-to-reference guide, starting
with the former 'toctree' document. There are no changes to the content.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00