Commit Graph

13 Commits

Author SHA1 Message Date
Michaël Defferrard
5e5bd748e6
remove repeted word in reStructuredText Primer 2020-05-20 22:30:58 +02: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
Stephen Finucane
b595c4a45b doc: Add "builders" to usage guide
This is placed in a directory as this document will eventually be split
up. However, this is not the day to do this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:26:59 +01:00
Takeshi KOMIYA
8e6c04c630
Merge branch 'master' into deprecate_highlightlang_directive 2018-04-29 21:13:13 +09:00
Takeshi KOMIYA
b35198d847 Deprecate highlightlang directive
highlightlang directive is not documented, and marked as old in v0.2.
2018-04-15 00:33:02 +09:00
Gussie Carther
390ea6d35a Fix #4420: Docs conflict on use of rst_prolog and rst_epilog 2018-04-14 17:51:06 +09:00
jfbu
525f3bd104 Typo from #4801 2018-04-01 11:39:58 +02:00
Tim Graham
725d20b0f9 Add section labels for intersphinx 2018-03-29 13:23:39 -04: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
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
Stephen Finucane
08ff8160b8 doc: Add "field-lists" doc to restructuredtext section
These are very poorly documented at present, especially given their
power and use in basically all non-Napoleon based Python documentation.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:25 +01:00
Stephen Finucane
3fcb1bd2dd doc: Add "roles" doc to restructuredtext section
This is essentially the 'markup/inline' with a few small fixes. There
are also some modifications to the basic rST guide to highlight what a
role is; we were doing this for directives but not roles.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:34:36 +01:00
Stephen Finucane
9c2ab8c3bb doc: Add "restructuredtext" section to usage guide
This is taken from the existing 'rest' documents. Little to no
modifications are necessary, thankfully.

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