summary refs log tree commit diff
path: root/docs/documentation_style
diff options
context:
space:
mode:
authorMark Haines <mark.haines@matrix.org>2014-08-12 16:05:23 +0100
committerMark Haines <mark.haines@matrix.org>2014-08-12 16:39:35 +0100
commitcf45ed1bc0bb23917001b63adaca7fd126c64996 (patch)
tree79ccb12349f7b8f6ce954bf5373c6282bc898fd9 /docs/documentation_style
parentReference Matrix Home Server (diff)
downloadsynapse-cf45ed1bc0bb23917001b63adaca7fd126c64996.tar.xz
Add .rst suffix to documentation files so that github auto-formats them
Diffstat (limited to 'docs/documentation_style')
-rw-r--r--docs/documentation_style43
1 files changed, 0 insertions, 43 deletions
diff --git a/docs/documentation_style b/docs/documentation_style
deleted file mode 100644
index c365d09dff..0000000000
--- a/docs/documentation_style
+++ /dev/null
@@ -1,43 +0,0 @@
-===================
-Documentation Style
-===================
-
-A brief single sentence to describe what this file contains; in this case a
-description of the style to write documentation in.
-
-
-Sections
-========
-
-Each section should be separated from the others by two blank lines. Headings
-should be underlined using a row of equals signs (===). Paragraphs should be
-separated by a single blank line, and wrap to no further than 80 columns.
-
-[[TODO(username): if you want to leave some unanswered questions, notes for
-further consideration, or other kinds of comment, use a TODO section. Make sure
-to notate it with your name so we know who to ask about it!]]
-
-Subsections
------------
-
-If required, subsections can use a row of dashes to underline their header. A
-single blank line between subsections of a single section.
-
-
-Bullet Lists
-============
-
- * Bullet lists can use asterisks with a single space either side.
- 
- * Another blank line between list elements.
-
-
-Definition Lists
-================
-
-Terms:
-  Start in the first column, ending with a colon
-
-Definitions:
-  Take a two space indent, following immediately from the term without a blank
-  line before it, but having a blank line afterwards.