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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>How to build this documentation from the source — MIT Kerberos Documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/agogo.css?v=879f3c71" />
<link rel="stylesheet" type="text/css" href="_static/kerb.css?v=6a0b3979" />
<script src="_static/documentation_options.js?v=6dbce55c"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="next" title="Contributing to the MIT Kerberos Documentation" href="about.html" />
<link rel="prev" title="Copyright" href="copyright.html" />
</head><body>
<div class="header-wrapper">
<div class="header">
<h1><a href="index.html">MIT Kerberos Documentation</a></h1>
<div class="rel">
<a href="index.html" title="Full Table of Contents"
accesskey="C">Contents</a> |
<a href="copyright.html" title="Copyright"
accesskey="P">previous</a> |
<a href="about.html" title="Contributing to the MIT Kerberos Documentation"
accesskey="N">next</a> |
<a href="genindex.html" title="General Index"
accesskey="I">index</a> |
<a href="search.html" title="Enter search criteria"
accesskey="S">Search</a> |
<a href="mailto:krb5-bugs@mit.edu?subject=Documentation__How to build this documentation from the source">feedback</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="how-to-build-this-documentation-from-the-source">
<h1>How to build this documentation from the source<a class="headerlink" href="#how-to-build-this-documentation-from-the-source" title="Link to this heading">¶</a></h1>
<p>Pre-requisites for a simple build, or to update man pages:</p>
<ul class="simple">
<li><p>Sphinx 1.0.4 or higher (See <a class="reference external" href="https://www.sphinx-doc.org">https://www.sphinx-doc.org</a>) with the
autodoc extension installed.</p></li>
</ul>
<p>Additional prerequisites to include the API reference based on Doxygen
markup:</p>
<ul class="simple">
<li><p>Python 2.5 with the Cheetah, lxml, and xml modules</p></li>
<li><p>Doxygen</p></li>
</ul>
<section id="simple-build-without-api-reference">
<h2>Simple build without API reference<a class="headerlink" href="#simple-build-without-api-reference" title="Link to this heading">¶</a></h2>
<p>To test simple changes to the RST sources, you can build the
documentation without the Doxygen reference by running, from the doc
directory:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sphinx</span><span class="o">-</span><span class="n">build</span> <span class="o">.</span> <span class="n">test_html</span>
</pre></div>
</div>
<p>You will see a number of warnings about missing files. This is
expected. If there is not already a <code class="docutils literal notranslate"><span class="pre">doc/version.py</span></code> file, you will
need to create one by first running <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">version.py</span></code> in the
<code class="docutils literal notranslate"><span class="pre">src/doc</span></code> directory of a configured build tree.</p>
</section>
<section id="updating-man-pages">
<h2>Updating man pages<a class="headerlink" href="#updating-man-pages" title="Link to this heading">¶</a></h2>
<p>Man pages are generated from the RST sources and checked into the
<code class="docutils literal notranslate"><span class="pre">src/man</span></code> directory of the repository. This allows man pages to be
installed without requiring Sphinx when using a source checkout. To
regenerate these files, run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">man</span></code> from the man subdirectory
of a configured build tree. You can also do this from an unconfigured
source tree with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">src</span><span class="o">/</span><span class="n">man</span>
<span class="n">make</span> <span class="o">-</span><span class="n">f</span> <span class="n">Makefile</span><span class="o">.</span><span class="ow">in</span> <span class="n">top_srcdir</span><span class="o">=..</span> <span class="n">srcdir</span><span class="o">=.</span> <span class="n">man</span>
<span class="n">make</span> <span class="n">clean</span>
</pre></div>
</div>
<p>As with the simple build, it is normal to see warnings about missing
files when rebuilding the man pages.</p>
</section>
<section id="building-for-a-release-tarball-or-web-site">
<h2>Building for a release tarball or web site<a class="headerlink" href="#building-for-a-release-tarball-or-web-site" title="Link to this heading">¶</a></h2>
<p>To generate documentation in HTML format, run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">html</span></code> in the
<code class="docutils literal notranslate"><span class="pre">doc</span></code> subdirectory of a configured build tree (the build directory
corresponding to <code class="docutils literal notranslate"><span class="pre">src/doc</span></code>, not the top-level <code class="docutils literal notranslate"><span class="pre">doc</span></code> directory).
The output will be placed in the top-level <code class="docutils literal notranslate"><span class="pre">doc/html</span></code> directory.
This build will include the API reference generated from Doxygen
markup in the source tree.</p>
<p>Documentation generated this way will use symbolic names for paths
(like <code class="docutils literal notranslate"><span class="pre">BINDIR</span></code> for the directory containing user programs), with the
symbolic names being links to a table showing typical values for those
paths.</p>
<p>You can also do this from an unconfigured source tree with:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">src</span><span class="o">/</span><span class="n">doc</span>
<span class="n">make</span> <span class="o">-</span><span class="n">f</span> <span class="n">Makefile</span><span class="o">.</span><span class="ow">in</span> <span class="n">SPHINX_ARGS</span><span class="o">=</span> <span class="n">htmlsrc</span>
</pre></div>
</div>
</section>
<section id="building-for-an-os-package-or-site-documentation">
<h2>Building for an OS package or site documentation<a class="headerlink" href="#building-for-an-os-package-or-site-documentation" title="Link to this heading">¶</a></h2>
<p>To generate documentation specific to a build of MIT krb5 as you have
configured it, run <code class="docutils literal notranslate"><span class="pre">make</span> <span class="pre">substhtml</span></code> in the <code class="docutils literal notranslate"><span class="pre">doc</span></code> subdirectory of a
configured build tree (the build directory corresponding to
<code class="docutils literal notranslate"><span class="pre">src/doc</span></code>, not the top-level <code class="docutils literal notranslate"><span class="pre">doc</span></code> directory). The output will be
placed in the <code class="docutils literal notranslate"><span class="pre">html_subst</span></code> subdirectory of that build directory.
This build will include the API reference.</p>
<p>Documentation generated this way will use concrete paths (like
<code class="docutils literal notranslate"><span class="pre">/usr/local/bin</span></code> for the directory containing user programs, for a
default custom build).</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h2>On this page</h2>
<ul>
<li><a class="reference internal" href="#">How to build this documentation from the source</a><ul>
<li><a class="reference internal" href="#simple-build-without-api-reference">Simple build without API reference</a></li>
<li><a class="reference internal" href="#updating-man-pages">Updating man pages</a></li>
<li><a class="reference internal" href="#building-for-a-release-tarball-or-web-site">Building for a release tarball or web site</a></li>
<li><a class="reference internal" href="#building-for-an-os-package-or-site-documentation">Building for an OS package or site documentation</a></li>
</ul>
</li>
</ul>
<br/>
<h2>Table of contents</h2>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="user/index.html">For users</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/index.html">For administrators</a></li>
<li class="toctree-l1"><a class="reference internal" href="appdev/index.html">For application developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugindev/index.html">For plugin module developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="build/index.html">Building Kerberos V5</a></li>
<li class="toctree-l1"><a class="reference internal" href="basic/index.html">Kerberos V5 concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="formats/index.html">Protocols and file formats</a></li>
<li class="toctree-l1"><a class="reference internal" href="mitK5features.html">MIT Kerberos features</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">How to build this documentation from the source</a></li>
<li class="toctree-l1"><a class="reference internal" href="about.html">Contributing to the MIT Kerberos Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
</ul>
<br/>
<h4><a href="index.html">Full Table of Contents</a></h4>
<h4>Search</h4>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer" >
<div class="right" ><i>Release: 1.22.1</i><br />
© <a href="copyright.html">Copyright</a> 1985-2025, MIT.
</div>
<div class="left">
<a href="index.html" title="Full Table of Contents"
>Contents</a> |
<a href="copyright.html" title="Copyright"
>previous</a> |
<a href="about.html" title="Contributing to the MIT Kerberos Documentation"
>next</a> |
<a href="genindex.html" title="General Index"
>index</a> |
<a href="search.html" title="Enter search criteria"
>Search</a> |
<a href="mailto:krb5-bugs@mit.edu?subject=Documentation__How to build this documentation from the source">feedback</a>
</div>
</div>
</div>
</body>
</html>
|
