summaryrefslogtreecommitdiffstats
path: root/doc/development/documentation.txt
diff options
context:
space:
mode:
authorFabian Affolter <fabian@bernewireless.net>2010-12-13 23:26:31 +0100
committerFabian Affolter <fabian@bernewireless.net>2010-12-13 23:26:31 +0100
commit875aefd9beb9e7fd464348c0e0fa42896dc329ff (patch)
tree6c9920648f7c56a9a5854c1dafa474d8e8139508 /doc/development/documentation.txt
parentf5792d907e357c90624ec110d908d42b94296a12 (diff)
parent71bb583ac04ff1c52e03d69a91bbb508783566f8 (diff)
downloadbcfg2-875aefd9beb9e7fd464348c0e0fa42896dc329ff.tar.gz
bcfg2-875aefd9beb9e7fd464348c0e0fa42896dc329ff.tar.bz2
bcfg2-875aefd9beb9e7fd464348c0e0fa42896dc329ff.zip
Merge remote branch 'upstream/master'
Diffstat (limited to 'doc/development/documentation.txt')
-rw-r--r--doc/development/documentation.txt37
1 files changed, 16 insertions, 21 deletions
diff --git a/doc/development/documentation.txt b/doc/development/documentation.txt
index 8223670b8..0f75b9bba 100644
--- a/doc/development/documentation.txt
+++ b/doc/development/documentation.txt
@@ -19,22 +19,23 @@ The wiki
.. _MCS: http://www.mcs.anl.gov/
.. _Argonne National Laboratory: http://www.anl.gov/
-A python-based Trac_ instance is used for the Bcfg2 website. The
-Wiki_ part of the website can be edited after you have successful
-logged in. For the login is a vaild OpenID provider needed and an
-interaction from an administrator. Please request your access to
-the Wiki_ on the :ref:`mailinglist` or in the :ref:`ircchannel`.
+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:
+.. _Docutils:
-The source for the manual is located in the `doc/` directory in the
-SVN repository or in the source tarball. All files are written in
-rst_ (ReStructuredText). For the build process we are using Sphinx_.
+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
^^^^^^^^^^^^^^^^^^^
@@ -42,7 +43,7 @@ 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::
@@ -56,20 +57,14 @@ Building the Manual
* Download the source. Please refer to :ref:`source` for more details.
-* Building the HTML version, run the following command in the `doc/` directory. The output will appear in `../build/sphinx/html`::
+* 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
+
+ python setup.py build_sphinx --builder=latex
cd build/sphinx/latex
make
-
-The latest version of the manual
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The latest version of the manual can always be found
-`on the Four Kitchens server <http://doc.bcfg2.fourkitchens.com/>`_.
-
-This is an auto-updated from the `Launchpad mirror <https://code.launchpad.net/~vcs-imports/bcfg2/trunk>`_.