From 6a776ece0f3aaab4a06f6bbac06c82ed17d3d621 Mon Sep 17 00:00:00 2001 From: Robert Göhler Date: Sun, 24 Nov 2019 16:23:44 +0100 Subject: contributing: add section to style guide --- docs/contributing/documentation.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'docs/contributing/documentation.rst') diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 3f088455..c89be9d4 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -83,6 +83,33 @@ This requires you already have a GitHub account. Style Guide ----------- +Sections +^^^^^^^^ + +We use the following syntax for Headlines. + +.. code-block:: sh + + ##### + Parts + ##### + + ******** + Chapters + ******** + + Sections + ======== + + Subsections + ----------- + + Subsubsections + ^^^^^^^^^^^^^^ + + Paragraphs + """""""""" + Address space ^^^^^^^^^^^^^ -- cgit v1.2.3