summaryrefslogtreecommitdiff
path: root/doc/markup
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2017-11-03 14:35:20 +0000
committerStephen Finucane <stephen@that.guru>2018-03-27 15:37:25 +0100
commit08ff8160b8a6d9879430710e51a905d843ec66a3 (patch)
treeefa225c970f262606d39486a96004c062a9698d5 /doc/markup
parent3fcb1bd2dd4505bed942581178474d49c277d623 (diff)
downloadsphinx-git-08ff8160b8a6d9879430710e51a905d843ec66a3.tar.gz
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>
Diffstat (limited to 'doc/markup')
-rw-r--r--doc/markup/misc.rst35
1 files changed, 0 insertions, 35 deletions
diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst
index afff2ae27..a4fbce5a0 100644
--- a/doc/markup/misc.rst
+++ b/doc/markup/misc.rst
@@ -3,41 +3,6 @@
Miscellaneous markup
====================
-.. _metadata:
-
-File-wide metadata
-------------------
-
-reST has the concept of "field lists"; these are a sequence of fields marked up
-like this::
-
- :fieldname: Field content
-
-A field list near the top of a file is parsed by docutils as the "docinfo"
-which is normally used to record the author, date of publication and other
-metadata. *In Sphinx*, a field list preceding any other markup is moved from
-the docinfo to the Sphinx environment as document metadata and is not displayed
-in the output; a field list appearing after the document title will be part of
-the docinfo as normal and will be displayed in the output.
-
-At the moment, these metadata fields are recognized:
-
-``tocdepth``
- The maximum depth for a table of contents of this file.
-
- .. versionadded:: 0.4
-
-``nocomments``
- If set, the web application won't display a comment form for a page generated
- from this source file.
-
-``orphan``
- If set, warnings about this file not being included in any toctree will be
- suppressed.
-
- .. versionadded:: 1.0
-
-
Meta-information markup
-----------------------