blob: 1e7667cc58aab3c346e6dffdc757cf835900009f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
.. -*- mode: rst -*-
.. _development-documentation:
===============
Documentation
===============
There are two parts of documentation in the Bcfg2 project:
* The wiki
* The manual
The wiki
========
.. _Wiki: http://bcfg2.org
.. _Trac: http://trac.edgewall.org/
.. _OpenID: https://openid.org/
.. _MCS: http://www.mcs.anl.gov/
.. _Argonne National Laboratory: http://www.anl.gov/
A python-based Trac_ instance is used for the Bcfg2 development
website. The Wiki_ part of the website can be edited after you
have successfully logged in. In order to login, a vaild OpenID
provider is needed. Please request your access to the Wiki_ on the
:ref:`help-mailinglist` or in the :ref:`help-irc`.
The manual
==========
.. _rst: http://en.wikipedia.org/wiki/ReStructuredText
.. _Sphinx: http://sphinx.pocoo.org
.. _Docutils:
The source for the manual is located in the ``doc/`` directory in the
git repository or in the source tarball. All files are written in
rst_ (ReStructuredText) format. Sphinx_ is used to build the
documentation from the restructured text sources.
Building the Manual
-------------------
* Install the prerequisites. Docutils_ and Sphinx_ are needed to build.
* For Debian (Lenny) the tools are available in the `backports
<http://www.backports.org/dokuwiki/doku.php?id=instructionst>`_
repository; installation can be done with the following::
apt-get -t lenny-backports install python-sphinx
* The needed tools for Fedora based systems are in the `Fedora
Package Collection <https://admin.fedoraproject.org/pkgdb>`_;
installation can be done easily with Yum::
yum -y install python-sphinx python-docutils
* Additionally, to build the PDF version:
* LaTeX
* pdftex
* Download the source. Please refer to :ref:`source` for more details.
* Build the HTML version by running the following command in the
top level of the source directory. The output will appear in
``build/sphinx/html``::
python setup.py build_sphinx
* Building the PDF version ::
python setup.py build_sphinx --builder=latex
cd build/sphinx/latex
make
.. _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.
|
