This repository was archived by the owner on Apr 18, 2018. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +33
-54
lines changed Expand file tree Collapse file tree 2 files changed +33
-54
lines changed Original file line number Diff line number Diff 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 :
Load Diff This file was deleted.
You can’t perform that action at this time.
0 commit comments