summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSol Jerome <sol.jerome@gmail.com>2011-04-23 21:54:41 -0500
committerSol Jerome <sol.jerome@gmail.com>2011-04-23 21:54:41 -0500
commite9047ac894dc064a34bd8026f49fc186121b6cfc (patch)
treeb9c2c01654e8500935b2073fc246c62038a56ae2
parentca22f61e441563e46ac668c007fc10bb9e9694a9 (diff)
downloadbcfg2-e9047ac894dc064a34bd8026f49fc186121b6cfc.tar.gz
bcfg2-e9047ac894dc064a34bd8026f49fc186121b6cfc.tar.bz2
bcfg2-e9047ac894dc064a34bd8026f49fc186121b6cfc.zip
doc: Update style guide with Section header information
Signed-off-by: Sol Jerome <sol.jerome@gmail.com>
-rw-r--r--doc/development/docstyleguide.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt
index fda1037f3..59db58362 100644
--- a/doc/development/docstyleguide.txt
+++ b/doc/development/docstyleguide.txt
@@ -25,3 +25,9 @@ Basics
When used alone this refers to a Bcfg2 :term:`repository`. When there
is a chance for confusion, for instance in documents also talking
about :term:`VCS`, be sure to use the longer Bcfg2 :term:`repository`.
+
+Sections
+--------
+
+Unless necessary, all the documentation follows the sections header
+rules available at http://docs.python.org/documenting/rest.html#sections.