From cf45ed1bc0bb23917001b63adaca7fd126c64996 Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Tue, 12 Aug 2014 16:05:23 +0100 Subject: Add .rst suffix to documentation files so that github auto-formats them --- docs/documentation_style | 43 ------------------------------------------- 1 file changed, 43 deletions(-) delete mode 100644 docs/documentation_style (limited to 'docs/documentation_style') 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. -- cgit 1.5.1