diff options
| author | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-10-11 15:03:59 -0400 |
|---|---|---|
| committer | Chris St. Pierre <chris.a.st.pierre@gmail.com> | 2012-10-11 15:04:21 -0400 |
| commit | b08e0a1b894038a8de8234a21ec9322271102867 (patch) | |
| tree | 29e10155079f464271169c81cbc4982be6ab74c7 /doc/development/docstyleguide.txt | |
| parent | 281818e0b25b08d2fa5015c402abd7a4956afd42 (diff) | |
| download | bcfg2-b08e0a1b894038a8de8234a21ec9322271102867.tar.gz bcfg2-b08e0a1b894038a8de8234a21ec9322271102867.tar.bz2 bcfg2-b08e0a1b894038a8de8234a21ec9322271102867.zip | |
doc: merged two documents about development documentation
Diffstat (limited to 'doc/development/docstyleguide.txt')
| -rw-r--r-- | doc/development/docstyleguide.txt | 33 |
1 files changed, 0 insertions, 33 deletions
diff --git a/doc/development/docstyleguide.txt b/doc/development/docstyleguide.txt deleted file mode 100644 index 59db58362..000000000 --- a/doc/development/docstyleguide.txt +++ /dev/null @@ -1,33 +0,0 @@ -.. -*- mode: rst -*- - -.. _doc-styleguide: - -Documentation Style Guide for Bcfg2 -=================================== - -This is a style guide to use when creating documentation for Bcfg2. It -is meant to be helpful, not a hinderence. - -Basics ------- - -**Bcfg2** - - When referring to project, Bcfg2 is the preferred use of cases. - -**Monospace fonts** - - When referring to commands written on the command line use monospace - fonts. - -**Repository** - - 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. |