/usr/share/doc/python-openstack-doc-tools/html/readme.html is in python-openstack-doc-tools 0.34.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 201 202 203 | <!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>OpenStack Doc Tools — openstack-doc-tools documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
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>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="top" title="openstack-doc-tools documentation" href="index.html" />
<link rel="next" title="Release notes" href="release_notes.html" />
<link rel="prev" title="Welcome to openstack-doc-tool’s documentation!" href="index.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="openstack-doc-tools">
<h1>OpenStack Doc Tools<a class="headerlink" href="#openstack-doc-tools" title="Permalink to this headline">¶</a></h1>
<p>This repository contains tools used by the OpenStack Documentation
project.</p>
<p>For more details, see the <a class="reference external" href="http://wiki.openstack.org/Documentation">OpenStack Documentation wiki page</a>.</p>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
<p><a class="reference external" href="http://maven.apache.org/">Apache Maven</a> must be installed to build the
documentation.</p>
<p>To install Maven 3 for Ubuntu 12.04 and later, and Debian wheezy and later:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">maven</span>
</pre></div>
</div>
<p>On Fedora:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">yum</span> <span class="n">install</span> <span class="n">maven</span>
</pre></div>
</div>
<p>You need to have Python 2.7 installed for using the tools.</p>
<p>This package needs a few external dependencies including lxml. If you
do not have lxml installed, you can either install python-lxml or have
it installed automatically and build from sources. To build lxml from
sources, you need a C compiler and the xml and xslt development
packages installed.</p>
<p>To install python-lxml, execute the following based on your
distribution.</p>
<p>On Fedora:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">yum</span> <span class="n">install</span> <span class="n">python</span><span class="o">-</span><span class="n">lxml</span>
</pre></div>
</div>
<p>On openSUSE:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">zypper</span> <span class="ow">in</span> <span class="n">python</span><span class="o">-</span><span class="n">lxml</span>
</pre></div>
</div>
<p>On Ubuntu:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">python</span><span class="o">-</span><span class="n">lxml</span>
</pre></div>
</div>
<p>For building from source, install the dependencies of lxml.</p>
<p>On Fedora:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">yum</span> <span class="n">install</span> <span class="n">python</span><span class="o">-</span><span class="n">devel</span> <span class="n">libxml2</span><span class="o">-</span><span class="n">devel</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">devel</span>
</pre></div>
</div>
<p>On openSUSE:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">zypper</span> <span class="ow">in</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">devel</span>
</pre></div>
</div>
<p>On Ubuntu:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">apt</span><span class="o">-</span><span class="n">get</span> <span class="n">install</span> <span class="n">libxml2</span><span class="o">-</span><span class="n">dev</span> <span class="n">libxslt</span><span class="o">-</span><span class="n">dev</span>
</pre></div>
</div>
</div>
<div class="section" id="updating-rng-schema-files">
<h2>Updating RNG schema files<a class="headerlink" href="#updating-rng-schema-files" title="Permalink to this headline">¶</a></h2>
<p>The repository contains in the directory <code class="docutils literal"><span class="pre">os_doc_tools/resources</span></code> a
local copy of some RNG schema files so that they do not need to be
downloaded each time for validation of XML and WADL files.</p>
<p>Please see the <code class="docutils literal"><span class="pre">README.txt</span></code> in the directory for details on where
these files come from.</p>
</div>
<div class="section" id="publishing-of-books">
<h2>Publishing of books<a class="headerlink" href="#publishing-of-books" title="Permalink to this headline">¶</a></h2>
<p>If you run the <code class="docutils literal"><span class="pre">openstack-doc-test</span> <span class="pre">--check-build</span></code>, it will copy all
the books to the directory <code class="docutils literal"><span class="pre">publish-docs</span></code> in the top-level directory
of your repository.</p>
<p>By default, it outputs a directory with the same name as the directory
where the pom.xml file lives in, such as admin-guide-cloud. You can
also check the output of the build job for the name.</p>
<p>Some books need special treatment and there are three options you can
set in the file <code class="docutils literal"><span class="pre">doc-test.conf</span></code>:</p>
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal"><span class="pre">book</span></code> - the name of a book that needs special treatment</li>
<li><code class="docutils literal"><span class="pre">target_dir</span></code> - the path of subdirectory starting at <code class="docutils literal"><span class="pre">target</span></code>
that is the root for publishing</li>
<li><code class="docutils literal"><span class="pre">publish_dir</span></code> - a new name to publish a book under</li>
</ul>
</div></blockquote>
<p>As an example, to publish the compute-api version 2 in the directory
<code class="docutils literal"><span class="pre">publish-docs/api/openstack-compute/2</span></code>, use:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">book</span> <span class="o">=</span> <span class="n">openstack</span><span class="o">-</span><span class="n">compute</span><span class="o">-</span><span class="n">api</span><span class="o">-</span><span class="mi">2</span>
<span class="n">target_dir</span> <span class="o">=</span> <span class="n">target</span><span class="o">/</span><span class="n">docbkx</span><span class="o">/</span><span class="n">webhelp</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="n">openstack</span><span class="o">-</span><span class="n">compute</span><span class="o">/</span><span class="mi">2</span>
<span class="n">publish_dir</span> <span class="o">=</span> <span class="n">api</span><span class="o">/</span><span class="n">openstack</span><span class="o">-</span><span class="n">compute</span><span class="o">/</span><span class="mi">2</span>
</pre></div>
</div>
<p>Note that these options can be specified multiple times and should
always be used this way. You do not need to set <code class="docutils literal"><span class="pre">publish_dir</span></code> but if
you set it, you need to use it every time.</p>
<p>Also note that these are optional settings, the logic in the tool is
sufficient for many of the books.</p>
<ul class="simple">
<li>License: Apache License, Version 2.0</li>
<li>Source: <a class="reference external" href="http://git.openstack.org/cgit/openstack/openstack-doc-tools">http://git.openstack.org/cgit/openstack/openstack-doc-tools</a></li>
<li>Bugs: <a class="reference external" href="http://bugs.launchpad.net/openstack-manuals">http://bugs.launchpad.net/openstack-manuals</a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">OpenStack Doc Tools</a><ul>
<li><a class="reference internal" href="#prerequisites">Prerequisites</a></li>
<li><a class="reference internal" href="#updating-rng-schema-files">Updating RNG schema files</a></li>
<li><a class="reference internal" href="#publishing-of-books">Publishing of books</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li>Previous: <a href="index.html" title="previous chapter">Welcome to openstack-doc-tool’s documentation!</a></li>
<li>Next: <a href="release_notes.html" title="next chapter">Release notes</a></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/readme.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, OpenStack Foundation.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/readme.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>
|