Skip to content

Commit b9d9085

Browse files
authored
Merge pull request #29 from tienhungvuong/source
DOC: fixed formatting of PDF and html footer.
2 parents 8b69b52 + 0a7d02f commit b9d9085

13 files changed

+20
-20
lines changed

Diff for: static_root/doc/pdfgetx/2.1.0/PDFgetXNS3_manual.pdf

215 Bytes
Binary file not shown.

Diff for: static_root/doc/pdfgetx/2.1.0/files.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ <h3>Navigation</h3>
189189
</div>
190190

191191
<div class="footer" role="contentinfo">
192-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
192+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
193193
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
194194
</div>
195195
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/genindex.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -837,7 +837,7 @@ <h3>Navigation</h3>
837837
</div>
838838

839839
<div class="footer" role="contentinfo">
840-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
840+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
841841
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
842842
</div>
843843
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ <h3>Navigation</h3>
172172
</div>
173173

174174
<div class="footer" role="contentinfo">
175-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
175+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
176176
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
177177
</div>
178178
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/install.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ <h3>Navigation</h3>
228228
</div>
229229

230230
<div class="footer" role="contentinfo">
231-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
231+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
232232
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
233233
</div>
234234
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/interact.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ <h1>Interactive mode<a class="headerlink" href="#interactive-mode" title="Permal
5252
the same syntax as the <strong class="program">pdfgetx3</strong> and <strong class="program">pdfgetn3</strong> in
5353
system shell.
5454
The interactive session is also initialized with all functions from the
55-
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="(in Matplotlib v3.2.2)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.pyplot</span></code></a> module for convenient plotting.
55+
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.html#module-matplotlib.pyplot" title="(in Matplotlib v3.3.0)"><code class="xref py py-mod docutils literal notranslate"><span class="pre">matplotlib.pyplot</span></code></a> module for convenient plotting.
5656
The functions and variables related to PDF processing are:</p>
5757
<dl class="function">
5858
<dt id="_interactive_.pdfgetter">
@@ -245,7 +245,7 @@ <h1>Interactive mode<a class="headerlink" href="#interactive-mode" title="Permal
245245
<dt class="field-odd">Parameters</dt>
246246
<dd class="field-odd"><ul class="simple">
247247
<li><p><strong>filenames</strong> (<em>str or an iterable of string file names</em>) – One or more text data files to be plotted.</p></li>
248-
<li><p><strong>style</strong> (<em>str</em>) – Optional style argument for the matplotlib <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="(in Matplotlib v3.2.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot()</span></code></a> function.</p></li>
248+
<li><p><strong>style</strong> (<em>str</em>) – Optional style argument for the matplotlib <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="(in Matplotlib v3.3.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot()</span></code></a> function.</p></li>
249249
<li><p><strong>x</strong> (<em>int, str, or iterable, optional</em>) – The column to be used for the x data. This can be a zero-based
250250
index of the desired column or a column name from data header.
251251
A special symbol “.” can be used for a sequential data index.
@@ -263,11 +263,11 @@ <h1>Interactive mode<a class="headerlink" href="#interactive-mode" title="Permal
263263
axis scaling when not specified.</p></li>
264264
<li><p><strong>ax</strong> (<em>matplotlib.axes.Axes, optional</em>) – The axes to plot to. The plotting will be performed using the
265265
<code class="docutils literal notranslate"><span class="pre">ax.plot</span></code> method. The default is <code class="docutils literal notranslate"><span class="pre">pyplot.gca()</span></code>.</p></li>
266-
<li><p><strong>kwargs</strong> (<em>misc, optional</em>) – Keyword arguments for the matplotlib <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="(in Matplotlib v3.2.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot()</span></code></a> function.</p></li>
266+
<li><p><strong>kwargs</strong> (<em>misc, optional</em>) – Keyword arguments for the matplotlib <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="(in Matplotlib v3.3.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">plot()</span></code></a> function.</p></li>
267267
</ul>
268268
</dd>
269269
<dt class="field-even">Returns</dt>
270-
<dd class="field-even"><p><strong>lines</strong> (<em>list</em>) – The matplotlib <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="(in Matplotlib v3.2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a> objects added to the current axis.</p>
270+
<dd class="field-even"><p><strong>lines</strong> (<em>list</em>) – The matplotlib <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.lines.Line2D.html#matplotlib.lines.Line2D" title="(in Matplotlib v3.3.0)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Line2D</span></code></a> objects added to the current axis.</p>
271271
</dd>
272272
</dl>
273273
<div class="admonition seealso">
@@ -378,7 +378,7 @@ <h3>Navigation</h3>
378378
</div>
379379

380380
<div class="footer" role="contentinfo">
381-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
381+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
382382
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
383383
</div>
384384
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/intro.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ <h3>Navigation</h3>
169169
</div>
170170

171171
<div class="footer" role="contentinfo">
172-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
172+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
173173
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
174174
</div>
175175
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/options.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -656,7 +656,7 @@ <h3>Navigation</h3>
656656
</div>
657657

658658
<div class="footer" role="contentinfo">
659-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
659+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
660660
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
661661
</div>
662662
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/plotdata.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ <h2>Selecting x and y data<a class="headerlink" href="#selecting-x-and-y-data" t
153153
<dt id="cmdoption-plotdata-s">
154154
<code class="sig-name descname">-s</code><code class="sig-prename descclassname"> STYLE</code><code class="sig-prename descclassname">, </code><code class="sig-name descname">--style</code><code class="sig-prename descclassname">=STYLE</code><a class="headerlink" href="#cmdoption-plotdata-s" title="Permalink to this definition"></a></dt>
155155
<dd><p>optional plot format specification. See the
156-
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="(in Matplotlib v3.2.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.plot()</span></code></a> function
156+
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.plot.html#matplotlib.pyplot.plot" title="(in Matplotlib v3.3.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">matplotlib.pyplot.plot()</span></code></a> function
157157
for a list of available formats.</p>
158158
</dd></dl>
159159

@@ -271,7 +271,7 @@ <h3>Navigation</h3>
271271
</div>
272272

273273
<div class="footer" role="contentinfo">
274-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
274+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
275275
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
276276
</div>
277277
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/quick-start.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ <h3>Navigation</h3>
243243
</div>
244244

245245
<div class="footer" role="contentinfo">
246-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
246+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
247247
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
248248
</div>
249249
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/release.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ <h3>Navigation</h3>
320320
</div>
321321

322322
<div class="footer" role="contentinfo">
323-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
323+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
324324
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
325325
</div>
326326
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/search.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <h3>Navigation</h3>
9090
</div>
9191

9292
<div class="footer" role="contentinfo">
93-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
93+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
9494
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
9595
</div>
9696
</body>

Diff for: static_root/doc/pdfgetx/2.1.0/tutorial.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -272,9 +272,9 @@ <h3>processing from scratch<a class="headerlink" href="#processing-from-scratch"
272272
variables for the original raw data and intermediate results. We
273273
are going to plot the “iq” variable that has the input intensities
274274
resampled on the <em>Q</em> grid. The matplotlib function
275-
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.clf.html#matplotlib.pyplot.clf" title="(in Matplotlib v3.2.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">clf()</span></code></a> clears the figure,
275+
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.clf.html#matplotlib.pyplot.clf" title="(in Matplotlib v3.3.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">clf()</span></code></a> clears the figure,
276276
the iq variable is a two-row matrix with <em>Q</em> and <em>I</em> rows, and the
277-
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.axis.html#matplotlib.pyplot.axis" title="(in Matplotlib v3.2.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">axis()</span></code></a>
277+
<a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.axis.html#matplotlib.pyplot.axis" title="(in Matplotlib v3.3.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">axis()</span></code></a>
278278
function lets us zoom to a given range:</p>
279279
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">1</span><span class="p">]:</span> <span class="n">clf</span><span class="p">()</span>
280280
<span class="n">In</span> <span class="p">[</span><span class="mi">2</span><span class="p">]:</span> <span class="n">plot</span><span class="p">(</span><span class="n">iq</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">iq</span><span class="p">[</span><span class="mi">1</span><span class="p">])</span>
@@ -540,7 +540,7 @@ <h3>output file names<a class="headerlink" href="#output-file-names" title="Perm
540540
In [5]: ax[0].legend(loc=2)
541541
</pre></div>
542542
</div>
543-
<p>The <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="(in Matplotlib v3.2.2)"><code class="xref py py-func docutils literal notranslate"><span class="pre">subplots()</span></code></a> function above
543+
<p>The <a class="reference external" href="https://matplotlib.org/api/_as_gen/matplotlib.pyplot.subplots.html#matplotlib.pyplot.subplots" title="(in Matplotlib v3.3.0)"><code class="xref py py-func docutils literal notranslate"><span class="pre">subplots()</span></code></a> function above
544544
is to create a new figure with 2 axes on top of each other.
545545
Overall, the code above should display the following plot
546546
and a GUI window:</p>
@@ -812,7 +812,7 @@ <h3>Navigation</h3>
812812
</div>
813813

814814
<div class="footer" role="contentinfo">
815-
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
815+
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Hung Vuong, Songsheng Tao, Simon Billinge.
816816
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
817817
</div>
818818
</body>

0 commit comments

Comments
 (0)