summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-11-20 22:01:15 -0800
committerSteve Piercy <web@stevepiercy.com>2016-11-20 22:01:15 -0800
commite33b2ce88af4fb6d9412757ca0ac4f6a95bfc578 (patch)
treeee56f9e5a323fa72260df305d72c8dc44f562869 /docs
parentc13e6cc241d1f52382435a56a18e791b6b9bbe1a (diff)
downloadpyramid-e33b2ce88af4fb6d9412757ca0ac4f6a95bfc578.tar.gz
pyramid-e33b2ce88af4fb6d9412757ca0ac4f6a95bfc578.tar.bz2
pyramid-e33b2ce88af4fb6d9412757ca0ac4f6a95bfc578.zip
add topic
Diffstat (limited to 'docs')
-rw-r--r--docs/style-guide.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/style-guide.rst b/docs/style-guide.rst
index 911949862..2304e9d6b 100644
--- a/docs/style-guide.rst
+++ b/docs/style-guide.rst
@@ -198,6 +198,8 @@ Paragraphs
A paragraph should be on one line. Paragraphs must be separated by two line feeds.
+.. _style-guide-links:
+
Links
^^^^^
@@ -208,7 +210,22 @@ Use inline links to keep the context or link label together with the URL. Do not
`Example <http://example.com>`_
+.. _style-guide-topic:
+
+Topic
+^^^^^
+
+A topic is similar to a block quote with a title, or a self-contained section with no subsections. Use the ``topic`` directive to indicate a self-contained idea that is separate from the flow of the document. Topics may occur anywhere a section or transition may occur. Body elements and topics may not contain nested topics.
+
+The directive's sole argument is interpreted as the topic title, and next line must be blank. All subsequent lines make up the topic body, interpreted as body elements.
+
+ .. code-block:: rst
+
+ .. topic:: Topic Title
+ Subsequent indented lines comprise
+ the body of the topic, and are
+ interpreted as body elements.
Literals, filenames, and function arguments are presented using the