Skip to content
This repository was archived by the owner on Apr 18, 2018. It is now read-only.

Commit 72aeedf

Browse files
edoddridgejahn
authored andcommitted
move manual guidelines into the manual
The contributions section now details how to make different headins, include mathematics, and cross reference within the document.
1 parent 738a1b5 commit 72aeedf

File tree

2 files changed

+33
-54
lines changed

2 files changed

+33
-54
lines changed

doc/contributing.rst

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,14 +48,43 @@ Contributing to the manual
4848
==========================
4949

5050

51+
Section headings
52+
++++++++++++++++
5153

52-
Quickstart Guide
53-
----------------
54+
Chapter headings - these are the main headings with integer numbers - underlined with ``****``
5455

56+
section headings - headings with number format X.Y - underlined with ``====``
5557

58+
subsection headings - headings with number format X.Y.Z - underlined with ``---``
5659

57-
Detailed guide
58-
--------------
60+
subsubsection headings - headings with number format X.Y.Z.A - underlined with ``+++``
61+
62+
paragraph headings - headings with no numbers - underlined with ``###``
63+
64+
N.B. all underlinings should be the same length as the heading
65+
66+
67+
Cross referencing
68+
+++++++++++++++++
69+
70+
Labels go above the section they refer to, with the format ``.. _LABELNAME:``. The leading underscore is important.
71+
72+
To reference sections by number use this format for the reference: ``section :numref:`sec_eg_baro```
73+
74+
To reference sections by name use this format: ``:ref:`sec_eg_baro```
75+
76+
77+
Maths
78+
+++++
79+
80+
Inline maths is done with ``:math:`LATEX_HERE```
81+
82+
Separate equations, which will be typeset on their own lines, are produced with::
83+
84+
.. math::
85+
:label: eqn_label_here
86+
87+
LATEX_HERE
5988

6089

6190
.. _subsec_manual_style_guide:

doc/manual_guidelines.txt

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)