Browse Source

rst conventions

pull/1/head
Sami Vaarala 11 years ago
parent
commit
ae1836306c
  1. 35
      doc/rst-conventions.txt
  2. 1
      make_full.sh

35
doc/rst-conventions.txt

@ -0,0 +1,35 @@
============================
reStructuredText conventions
============================
Section markers
===============
Book level:
#. Over- and underlined hash marks (``#``) for book title
#. Over- and underlines stars (``*``) for book sub-title
File level:
#. Over- and underlined equals signs (``=``) once at top of file (file topic)
#. Underlined equals signs (``=``)
#. Underlined minus signs (``-``)
#. Underlined colons (``:``)
#. Underlined periods (``.``)
The book level notation is reserved for future use. It allows the
internal documentation to be easily built into a single HTML/PDF
file for ease of browsing.
Page breaks
===========
See http://comments.gmane.org/gmane.text.docutils.user/6473.
You can use::
.. raw:: LaTeX
\newpage

1
make_full.sh

@ -27,6 +27,7 @@ for i in src/*.c src/*.h src/*.py src/*.txt; do
done
for i in \
doc/rst-conventions.txt \
doc/json.txt \
doc/datetime.txt \
doc/number_conversion.txt \

Loading…
Cancel
Save