doc/html/build_this.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>How to build this documentation from the source &mdash; MIT Kerberos Documentation</title>
  10
  11     <link rel="stylesheet" href="_static/agogo.css" type="text/css" />
  12     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  13     <link rel="stylesheet" href="_static/kerb.css" type="text/css" />
  14
  15     <script type="text/javascript">
  16       var DOCUMENTATION_OPTIONS = {
  17         URL_ROOT:    './',
  18         VERSION:     '1.15.1',
  19         COLLAPSE_INDEX: false,
  20         FILE_SUFFIX: '.html',
  21         HAS_SOURCE:  true
  22       };
  23     </script>
  24     <script type="text/javascript" src="_static/jquery.js"></script>
  25     <script type="text/javascript" src="_static/underscore.js"></script>
  26     <script type="text/javascript" src="_static/doctools.js"></script>
  27     <link rel="author" title="About these documents" href="about.html" />
  28     <link rel="copyright" title="Copyright" href="copyright.html" />
  29     <link rel="top" title="MIT Kerberos Documentation" href="index.html" />
  30     <link rel="next" title="Contributing to the MIT Kerberos Documentation" href="about.html" />
  31     <link rel="prev" title="Copyright" href="copyright.html" />
  32   </head>
  33   <body>
  34     <div class="header-wrapper">
  35         <div class="header">
  36
  37
  38             <h1><a href="index.html">MIT Kerberos Documentation</a></h1>
  39
  40             <div class="rel">
  41
  42         <a href="index.html" title="Full Table of Contents"
  43             accesskey="C">Contents</a> |
  44         <a href="copyright.html" title="Copyright"
  45             accesskey="P">previous</a> |
  46         <a href="about.html" title="Contributing to the MIT Kerberos Documentation"
  47             accesskey="N">next</a> |
  48         <a href="genindex.html" title="General Index"
  49             accesskey="I">index</a> |
  50         <a href="search.html" title="Enter search criteria"
  51             accesskey="S">Search</a> |
  52     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__How to build this documentation from the source">feedback</a>
  53             </div>
  54         </div>
  55     </div>
  56
  57     <div class="content-wrapper">
  58       <div class="content">
  59         <div class="document">
  60
  61       <div class="documentwrapper">
  62         <div class="bodywrapper">
  63           <div class="body">
  64
  65   <div class="section" id="how-to-build-this-documentation-from-the-source">
  66 <h1>How to build this documentation from the source<a class="headerlink" href="#how-to-build-this-documentation-from-the-source" title="Permalink to this headline">¶</a></h1>
  67 <p>Pre-requisites for a simple build, or to update man pages:</p>
  68 <ul class="simple">
  69 <li>Sphinx 1.0.4 or higher (See <a class="reference external" href="http://sphinx.pocoo.org">http://sphinx.pocoo.org</a>) with the autodoc
  70 extension installed.</li>
  71 </ul>
  72 <p>Additional prerequisites to include the API reference based on Doxygen
  73 markup:</p>
  74 <ul class="simple">
  75 <li>Python 2.5 with the Cheetah, lxml, and xml modules</li>
  76 <li>Doxygen</li>
  77 </ul>
  78 <div class="section" id="simple-build-without-api-reference">
  79 <h2>Simple build without API reference<a class="headerlink" href="#simple-build-without-api-reference" title="Permalink to this headline">¶</a></h2>
  80 <p>To test simple changes to the RST sources, you can build the
  81 documentation without the Doxygen reference by running, from the doc
  82 directory:</p>
  83 <div class="highlight-python"><div class="highlight"><pre><span class="n">sphinx</span><span class="o">-</span><span class="n">build</span> <span class="o">.</span> <span class="n">test_html</span>
  84 </pre></div>
  85 </div>
  86 <p>You will see a number of warnings about missing files.  This is
  87 expected.  If there is not already a <tt class="docutils literal"><span class="pre">doc/version.py</span></tt> file, you will
  88 need to create one by first running <tt class="docutils literal"><span class="pre">make</span> <span class="pre">version.py</span></tt> in the
  89 <tt class="docutils literal"><span class="pre">src/doc</span></tt> directory of a configured build tree.</p>
  90 </div>
  91 <div class="section" id="updating-man-pages">
  92 <h2>Updating man pages<a class="headerlink" href="#updating-man-pages" title="Permalink to this headline">¶</a></h2>
  93 <p>Man pages are generated from the RST sources and checked into the
  94 <tt class="docutils literal"><span class="pre">src/man</span></tt> directory of the repository.  This allows man pages to be
  95 installed without requiring Sphinx when using a source checkout.  To
  96 regenerate these files, run <tt class="docutils literal"><span class="pre">make</span> <span class="pre">man</span></tt> from the man subdirectory
  97 of a configured build tree.  You can also do this from an unconfigured
  98 source tree with:</p>
  99 <div class="highlight-python"><div class="highlight"><pre>cd src/man
 100 make -f Makefile.in top_srcdir=.. srcdir=. man
 101 make clean
 102 </pre></div>
 103 </div>
 104 <p>As with the simple build, it is normal to see warnings about missing
 105 files when rebuilding the man pages.</p>
 106 </div>
 107 <div class="section" id="building-for-a-release-tarball-or-web-site">
 108 <h2>Building for a release tarball or web site<a class="headerlink" href="#building-for-a-release-tarball-or-web-site" title="Permalink to this headline">¶</a></h2>
 109 <p>To generate documentation in HTML format, run <tt class="docutils literal"><span class="pre">make</span> <span class="pre">html</span></tt> in the
 110 <tt class="docutils literal"><span class="pre">doc</span></tt> subdirectory of a configured build tree (the build directory
 111 corresponding to <tt class="docutils literal"><span class="pre">src/doc</span></tt>, not the top-level <tt class="docutils literal"><span class="pre">doc</span></tt> directory).
 112 The output will be placed in the top-level <tt class="docutils literal"><span class="pre">doc/html</span></tt> directory.
 113 This build will include the API reference generated from Doxygen
 114 markup in the source tree.</p>
 115 <p>Documentation generated this way will use symbolic names for paths
 116 (like <tt class="docutils literal"><span class="pre">BINDIR</span></tt> for the directory containing user programs), with the
 117 symbolic names being links to a table showing typical values for those
 118 paths.</p>
 119 <p>You can also do this from an unconfigured source tree with:</p>
 120 <div class="highlight-python"><div class="highlight"><pre>cd src/doc
 121 make -f Makefile.in SPHINX_ARGS= htmlsrc
 122 </pre></div>
 123 </div>
 124 </div>
 125 <div class="section" id="building-for-an-os-package-or-site-documentation">
 126 <h2>Building for an OS package or site documentation<a class="headerlink" href="#building-for-an-os-package-or-site-documentation" title="Permalink to this headline">¶</a></h2>
 127 <p>To generate documentation specific to a build of MIT krb5 as you have
 128 configured it, run <tt class="docutils literal"><span class="pre">make</span> <span class="pre">substhtml</span></tt> in the <tt class="docutils literal"><span class="pre">doc</span></tt> subdirectory of a
 129 configured build tree (the build directory corresponding to
 130 <tt class="docutils literal"><span class="pre">src/doc</span></tt>, not the top-level <tt class="docutils literal"><span class="pre">doc</span></tt> directory).  The output will be
 131 placed in the <tt class="docutils literal"><span class="pre">html_subst</span></tt> subdirectory of that build directory.
 132 This build will include the API reference.</p>
 133 <p>Documentation generated this way will use concrete paths (like
 134 <tt class="docutils literal"><span class="pre">/usr/local/bin</span></tt> for the directory containing user programs, for a
 135 default custom build).</p>
 136 </div>
 137 </div>
 138
 139
 140           </div>
 141         </div>
 142       </div>
 143         </div>
 144         <div class="sidebar">
 145     <h2>On this page</h2>
 146     <ul>
 147 <li><a class="reference internal" href="#">How to build this documentation from the source</a><ul>
 148 <li><a class="reference internal" href="#simple-build-without-api-reference">Simple build without API reference</a></li>
 149 <li><a class="reference internal" href="#updating-man-pages">Updating man pages</a></li>
 150 <li><a class="reference internal" href="#building-for-a-release-tarball-or-web-site">Building for a release tarball or web site</a></li>
 151 <li><a class="reference internal" href="#building-for-an-os-package-or-site-documentation">Building for an OS package or site documentation</a></li>
 152 </ul>
 153 </li>
 154 </ul>
 155
 156     <br/>
 157     <h2>Table of contents</h2>
 158     <ul class="current">
 159 <li class="toctree-l1"><a class="reference internal" href="user/index.html">For users</a></li>
 160 <li class="toctree-l1"><a class="reference internal" href="admin/index.html">For administrators</a></li>
 161 <li class="toctree-l1"><a class="reference internal" href="appdev/index.html">For application developers</a></li>
 162 <li class="toctree-l1"><a class="reference internal" href="plugindev/index.html">For plugin module developers</a></li>
 163 <li class="toctree-l1"><a class="reference internal" href="build/index.html">Building Kerberos V5</a></li>
 164 <li class="toctree-l1"><a class="reference internal" href="basic/index.html">Kerberos V5 concepts</a></li>
 165 <li class="toctree-l1"><a class="reference internal" href="formats/index.html">Protocols and file formats</a></li>
 166 <li class="toctree-l1"><a class="reference internal" href="mitK5features.html">MIT Kerberos features</a></li>
 167 <li class="toctree-l1 current"><a class="current reference internal" href="">How to build this documentation from the source</a><ul class="simple">
 168 </ul>
 169 </li>
 170 <li class="toctree-l1"><a class="reference internal" href="about.html">Contributing to the MIT Kerberos Documentation</a></li>
 171 <li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
 172 </ul>
 173
 174     <br/>
 175     <h4><a href="index.html">Full Table of Contents</a></h4>
 176     <h4>Search</h4>
 177     <form class="search" action="search.html" method="get">
 178       <input type="text" name="q" size="18" />
 179       <input type="submit" value="Go" />
 180       <input type="hidden" name="check_keywords" value="yes" />
 181       <input type="hidden" name="area" value="default" />
 182     </form>
 183         </div>
 184         <div class="clearer"></div>
 185       </div>
 186     </div>
 187
 188     <div class="footer-wrapper">
 189         <div class="footer" >
 190             <div class="right" ><i>Release: 1.15.1</i><br />
 191                 &copy; <a href="copyright.html">Copyright</a> 1985-2017, MIT.
 192             </div>
 193             <div class="left">
 194
 195         <a href="index.html" title="Full Table of Contents"
 196             >Contents</a> |
 197         <a href="copyright.html" title="Copyright"
 198             >previous</a> |
 199         <a href="about.html" title="Contributing to the MIT Kerberos Documentation"
 200             >next</a> |
 201         <a href="genindex.html" title="General Index"
 202             >index</a> |
 203         <a href="search.html" title="Enter search criteria"
 204             >Search</a> |
 205     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__How to build this documentation from the source">feedback</a>
 206             </div>
 207         </div>
 208     </div>
 209
 210   </body>
 211 </html>