<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Documentation — Bcfg2 1.3.0 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '1.3.0', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="shortcut icon" href="../_static/favicon.ico"/> <link rel="top" title="Bcfg2 1.3.0 documentation" href="../index.html" /> <link rel="up" title="Bcfg2 Development" href="index.html" /> <link rel="next" title="File Monitor Development" href="fam.html" /> <link rel="prev" title="Server Core Development" href="core.html" /> <link rel="stylesheet" href="../_static/bcfg2.css" type=""/> </head> <body> <div style="text-align: left; padding: 10px 10px 15px 15px"> <a href="../index.html"><img src="../_static/bcfg2_logo.png" border="0" alt="sampledoc"/></a> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="fam.html" title="File Monitor Development" accesskey="N">next</a> |</li> <li class="right" > <a href="core.html" title="Server Core Development" accesskey="P">previous</a> |</li> <li><a href="../index.html">home</a> | </li> <!--<li><a href="../search.html">search</a> | </li>--> <li><a href="../help/index.html">help</a> | </li> <li><a href="../contents.html">documentation </a> »</li> <li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> »</li> <li><a href="index.html" accesskey="U">Bcfg2 Development</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="documentation"> <span id="development-documentation"></span><h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h1> <p>There are two parts of documentation in the Bcfg2 project:</p> <ul class="simple"> <li>The wiki</li> <li>The manual</li> </ul> <div class="section" id="the-wiki"> <h2>The wiki<a class="headerlink" href="#the-wiki" title="Permalink to this headline">¶</a></h2> <p>A python-based <a class="reference external" href="http://trac.edgewall.org/">Trac</a> instance is used for the Bcfg2 development website. The <a class="reference external" href="http://bcfg2.org">Wiki</a> 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 <a class="reference external" href="http://bcfg2.org">Wiki</a> on the <a class="reference internal" href="../help/mailinglist.html#help-mailinglist"><em>Mailing List</em></a> or in the <a class="reference internal" href="../help/irc.html#help-irc"><em>IRC Channel</em></a>.</p> </div> <div class="section" id="the-manual"> <h2>The manual<a class="headerlink" href="#the-manual" title="Permalink to this headline">¶</a></h2> <p id="docutils">The source for the manual is located in the <tt class="docutils literal"><span class="pre">doc/</span></tt> directory in the git repository or in the source tarball. All files are written in <a class="reference external" href="http://en.wikipedia.org/wiki/ReStructuredText">rst</a> (ReStructuredText) format. <a class="reference external" href="http://sphinx.pocoo.org">Sphinx</a> is used to build the documentation from the restructured text sources.</p> <div class="section" id="building-the-manual"> <h3>Building the Manual<a class="headerlink" href="#building-the-manual" title="Permalink to this headline">¶</a></h3> <ul class="simple"> <li>Install the prerequisites. <a class="reference internal" href="#docutils">Docutils</a> and <a class="reference external" href="http://sphinx.pocoo.org">Sphinx</a> are needed to build.</li> </ul> <blockquote> <div><ul> <li><p class="first">For Debian (Lenny) the tools are available in the <a class="reference external" href="http://www.backports.org/dokuwiki/doku.php?id=instructionst">backports</a> repository; installation can be done with the following:</p> <div class="highlight-python"><pre>apt-get -t lenny-backports install python-sphinx</pre> </div> </li> <li><p class="first">The needed tools for Fedora based systems are in the <a class="reference external" href="https://admin.fedoraproject.org/pkgdb">Fedora Package Collection</a>; installation can be done easily with Yum:</p> <div class="highlight-python"><pre>yum -y install python-sphinx python-docutils</pre> </div> </li> <li><p class="first">Additionally, to build the PDF version:</p> </li> </ul> <blockquote> <div><ul class="simple"> <li>LaTeX</li> <li>pdftex</li> </ul> </div></blockquote> </div></blockquote> <ul> <li><p class="first">Download the source. Please refer to <a class="reference internal" href="../installation/source.html#source"><em>Installation from source</em></a> for more details.</p> </li> <li><p class="first">Build the HTML version by running the following command in the top level of the source directory. The output will appear in <tt class="docutils literal"><span class="pre">build/sphinx/html</span></tt>:</p> <div class="highlight-python"><pre>python setup.py build_sphinx</pre> </div> </li> <li><p class="first">Building the PDF version</p> <div class="highlight-python"><pre>python setup.py build_sphinx --builder=latex cd build/sphinx/latex make</pre> </div> </li> </ul> </div> </div> <div class="section" id="documentation-style-guide-for-bcfg2"> <span id="doc-styleguide"></span><h2>Documentation Style Guide for Bcfg2<a class="headerlink" href="#documentation-style-guide-for-bcfg2" title="Permalink to this headline">¶</a></h2> <p>This is a style guide to use when creating documentation for Bcfg2. It is meant to be helpful, not a hinderence.</p> <div class="section" id="basics"> <h3>Basics<a class="headerlink" href="#basics" title="Permalink to this headline">¶</a></h3> <p><strong>Bcfg2</strong></p> <blockquote> <div>When referring to project, Bcfg2 is the preferred use of cases.</div></blockquote> <p><strong>Monospace fonts</strong></p> <blockquote> <div>When referring to commands written on the command line use <tt class="docutils literal"><span class="pre">monospace</span></tt> fonts.</div></blockquote> <p><strong>Repository</strong></p> <blockquote> <div>When used alone this refers to a Bcfg2 <a class="reference internal" href="../glossary.html#term-repository"><em class="xref std std-term">repository</em></a>. When there is a chance for confusion, for instance in documents also talking about <a class="reference internal" href="../glossary.html#term-vcs"><em class="xref std std-term">VCS</em></a>, be sure to use the longer Bcfg2 <a class="reference internal" href="../glossary.html#term-repository"><em class="xref std std-term">repository</em></a>.</div></blockquote> </div> <div class="section" id="sections"> <h3>Sections<a class="headerlink" href="#sections" title="Permalink to this headline">¶</a></h3> <p>Unless necessary, all the documentation follows the sections header rules available at <a class="reference external" href="http://docs.python.org/devguide/documenting.html#sections">http://docs.python.org/devguide/documenting.html#sections</a></p> </div> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="../index.html">Table Of Contents</a></h3> <ul> <li><a class="reference internal" href="#">Documentation</a><ul> <li><a class="reference internal" href="#the-wiki">The wiki</a></li> <li><a class="reference internal" href="#the-manual">The manual</a><ul> <li><a class="reference internal" href="#building-the-manual">Building the Manual</a></li> </ul> </li> <li><a class="reference internal" href="#documentation-style-guide-for-bcfg2">Documentation Style Guide for Bcfg2</a><ul> <li><a class="reference internal" href="#basics">Basics</a></li> <li><a class="reference internal" href="#sections">Sections</a></li> </ul> </li> </ul> </li> </ul> <h4>Previous topic</h4> <p class="topless"><a href="core.html" title="previous chapter">Server Core Development</a></p> <h4>Next topic</h4> <p class="topless"><a href="fam.html" title="next chapter">File Monitor Development</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../_sources/development/documentation.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="fam.html" title="File Monitor Development" >next</a> |</li> <li class="right" > <a href="core.html" title="Server Core Development" >previous</a> |</li> <li><a href="../index.html">home</a> | </li> <!--<li><a href="../search.html">search</a> | </li>--> <li><a href="../help/index.html">help</a> | </li> <li><a href="../contents.html">documentation </a> »</li> <li><a href="../contents.html" >Bcfg2 documentation 1.3.0</a> »</li> <li><a href="index.html" >Bcfg2 Development</a> »</li> </ul> </div> <div class="footer"> © Copyright 2009-2013, Narayan Desai. Last updated on Mar 20, 2013. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>