Skip to content

Commit 9b070c6

Browse files
domdfcodingdomdfcoding
committed
Changes for sphinx
1 parent 59e42d0 commit 9b070c6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+19250
-2
lines changed

‎docs/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: b264f46984e86b95a1a355372acd9fc4
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/.nojekyll

Whitespace-only changes.

‎docs/Building.html

Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,261 @@
1+
2+
3+
<!DOCTYPE html>
4+
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5+
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6+
<head>
7+
<meta charset="utf-8">
8+
9+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
10+
11+
<title>Building from source &mdash; domdf_python_tools 0.1.8 documentation</title>
12+
13+
14+
15+
16+
17+
18+
19+
20+
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
21+
22+
23+
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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+
<script type="text/javascript" src="_static/language_data.js"></script>
28+
29+
<script type="text/javascript" src="_static/js/theme.js"></script>
30+
31+
32+
33+
34+
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
35+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
36+
<link rel="index" title="Index" href="genindex.html" />
37+
<link rel="search" title="Search" href="search.html" />
38+
<link rel="prev" title="Downloading source code" href="Source.html" />
39+
</head>
40+
41+
<body class="wy-body-for-nav">
42+
43+
44+
<div class="wy-grid-for-nav">
45+
46+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
47+
<div class="wy-side-scroll">
48+
<div class="wy-side-nav-search" >
49+
50+
51+
52+
<a href="index.html" class="icon icon-home"> domdf_python_tools
53+
54+
55+
56+
</a>
57+
58+
59+
60+
61+
<div class="version">
62+
0.1.8
63+
</div>
64+
65+
66+
67+
68+
<div role="search">
69+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
70+
<input type="text" name="q" placeholder="Search docs" />
71+
<input type="hidden" name="check_keywords" value="yes" />
72+
<input type="hidden" name="area" value="default" />
73+
</form>
74+
</div>
75+
76+
77+
</div>
78+
79+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
80+
81+
82+
83+
84+
85+
86+
<p class="caption"><span class="caption-text">Documentation</span></p>
87+
<ul class="current">
88+
<li class="toctree-l1"><a class="reference internal" href="docs.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">domdf_python_tools</span></code></a></li>
89+
<li class="toctree-l1"><a class="reference internal" href="Source.html">Downloading source code</a></li>
90+
<li class="toctree-l1 current"><a class="current reference internal" href="#">Building from source</a></li>
91+
</ul>
92+
93+
94+
95+
</div>
96+
</div>
97+
</nav>
98+
99+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
100+
101+
102+
<nav class="wy-nav-top" aria-label="top navigation">
103+
104+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
105+
<a href="index.html">domdf_python_tools</a>
106+
107+
</nav>
108+
109+
110+
<div class="wy-nav-content">
111+
112+
<div class="rst-content">
113+
114+
115+
116+
117+
118+
119+
120+
121+
122+
123+
124+
125+
126+
127+
128+
129+
130+
<div role="navigation" aria-label="breadcrumbs navigation">
131+
132+
<ul class="wy-breadcrumbs">
133+
134+
<li><a href="index.html">Docs</a> &raquo;</li>
135+
136+
<li>Building from source</li>
137+
138+
139+
<li class="wy-breadcrumbs-aside">
140+
141+
142+
143+
<a href="https://github.com/domdfcoding/domdf_python_tools/blob/master/Building.rst" class="fa fa-github"> Edit on GitHub</a>
144+
145+
146+
147+
</li>
148+
149+
</ul>
150+
151+
152+
<hr/>
153+
</div>
154+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
155+
<div itemprop="articleBody">
156+
157+
<div class="section" id="building-from-source">
158+
<h1>Building from source<a class="headerlink" href="#building-from-source" title="Permalink to this headline"></a></h1>
159+
<p>To build the domdf_python_tools package from source using <code class="docutils literal notranslate"><span class="pre">setuptools</span></code>, run the following command:</p>
160+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ python3 setup.py sdist bdist_wheel
161+
</pre></div>
162+
</div>
163+
<p><code class="docutils literal notranslate"><span class="pre">setuptools</span></code> is configured using the file <a class="reference download internal" download="" href="_downloads/8c9b91ca40aa5ce1f372e21994db7587/setup.py"><code class="xref download docutils literal notranslate"><span class="pre">setup.py</span></code></a>.</p>
164+
<p>Different formats are available for built distributions</p>
165+
<table class="docutils align-center">
166+
<colgroup>
167+
<col style="width: 33%" />
168+
<col style="width: 33%" />
169+
<col style="width: 33%" />
170+
</colgroup>
171+
<thead>
172+
<tr class="row-odd"><th class="head"><p>Format</p></th>
173+
<th class="head"><p>Description</p></th>
174+
<th class="head"><p>Notes</p></th>
175+
</tr>
176+
</thead>
177+
<tbody>
178+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">gztar</span></code></p></td>
179+
<td><p>gzipped tar file (<code class="docutils literal notranslate"><span class="pre">.tar.gz</span></code>)</p></td>
180+
<td><p>default on Unix</p></td>
181+
</tr>
182+
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">bztar</span></code></p></td>
183+
<td><p>bzipped tar file (<code class="docutils literal notranslate"><span class="pre">.tar.bz2</span></code>)</p></td>
184+
<td></td>
185+
</tr>
186+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">xztar</span></code></p></td>
187+
<td><p>bzipped tar file (<code class="docutils literal notranslate"><span class="pre">.tar.bz2</span></code>)</p></td>
188+
<td></td>
189+
</tr>
190+
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">tar</span></code></p></td>
191+
<td><p>tar file (<code class="docutils literal notranslate"><span class="pre">.tar</span></code>)</p></td>
192+
<td></td>
193+
</tr>
194+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">zip</span></code></p></td>
195+
<td><p>zip file (<code class="docutils literal notranslate"><span class="pre">.zip</span></code>)</p></td>
196+
<td><p>default on Windows</p></td>
197+
</tr>
198+
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">wininst</span></code></p></td>
199+
<td><p>self-extracting ZIP file for Windows</p></td>
200+
<td></td>
201+
</tr>
202+
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">msi</span></code></p></td>
203+
<td><p>Microsoft Installer</p></td>
204+
<td></td>
205+
</tr>
206+
</tbody>
207+
</table>
208+
<div class="line-block">
209+
<div class="line"><br /></div>
210+
</div>
211+
<p><strong>setup.py</strong></p>
212+
</div>
213+
214+
215+
</div>
216+
217+
</div>
218+
<footer>
219+
220+
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
221+
222+
223+
<a href="Source.html" class="btn btn-neutral float-left" title="Downloading source code" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
224+
225+
</div>
226+
227+
228+
<hr/>
229+
230+
<div role="contentinfo">
231+
<p>
232+
&copy; Copyright 2014-2019 Dominic Davis-Foster
233+
234+
</p>
235+
</div>
236+
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
237+
238+
</footer>
239+
240+
</div>
241+
</div>
242+
243+
</section>
244+
245+
</div>
246+
247+
248+
249+
<script type="text/javascript">
250+
jQuery(function () {
251+
SphinxRtdTheme.Navigation.enable(true);
252+
});
253+
</script>
254+
255+
256+
257+
258+
259+
260+
</body>
261+
</html>

0 commit comments

Comments
 (0)