Skip to content

Commit 8b69b52

Browse files
sbillingesbillinge
authored
Merge pull request #28 from tienhungvuong/source
DOC: add updated pdfgetx v2.1.0 user manual to source
2 parents 9a3e01b + cee3f19 commit 8b69b52

23 files changed

+152
-139
lines changed

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

881 Bytes
Binary file not shown.

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_sources/install.rst.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Software requirements
77
------------------------------------------------------------------------
88

99
This software is written in Python programming language, therefore
10-
you must have Python 3.7, 3.6, 3.5, 3.4 or 2.7 installed. In addition,
10+
you must have Python 3.7, 3.6, 3.5 or 2.7 installed. In addition,
1111
the following third-party Python libraries are also required:
1212

1313
* pip - Python package installer

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_sources/intro.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ Timur Davis,
3434
Chia-Hao (Timothy) Liu,
3535
Christopher Wright,
3636
Christopher Farrow,
37+
Hung Vuong,
38+
Songsheng Tao,
3739
Simon Billinge.
3840

3941

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_static/basic.css

+5-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -672,6 +672,10 @@ div.code-block-caption + div > div.highlight > pre {
672672
margin-top: 0;
673673
}
674674

675+
div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
676+
user-select: none;
677+
}
678+
675679
div.code-block-caption span.caption-number {
676680
padding: 0.1em 0.3em;
677681
font-style: italic;

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_static/classic.css

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- classic theme.
66
*
7-
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_static/doctools.js

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -283,10 +283,11 @@ var Documentation = {
283283
},
284284

285285
initOnKeyListeners: function() {
286-
$(document).keyup(function(event) {
286+
$(document).keydown(function(event) {
287287
var activeElementType = document.activeElement.tagName;
288288
// don't navigate when in search box or textarea
289-
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
289+
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
290+
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
290291
switch (event.keyCode) {
291292
case 37: // left
292293
var prevHref = $('link[rel="prev"]').prop('href');

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_static/documentation_options.js

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ var DOCUMENTATION_OPTIONS = {
33
VERSION: '2.1.0',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
6+
BUILDER: 'html',
67
FILE_SUFFIX: '.html',
78
HAS_SOURCE: true,
89
SOURCELINK_SUFFIX: '.txt',

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_static/language_data.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* This script contains the language-specific data used by searchtools.js,
66
* namely the list of stopwords, stemmer, scorer and splitter.
77
*
8-
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
8+
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
99
* :license: BSD, see LICENSE for details.
1010
*
1111
*/

Diff for: ‎static_root/doc/pdfgetx/2.1.0/_static/searchtools.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for the full-text search.
66
*
7-
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -245,7 +245,7 @@ var Search = {
245245
if (results.length) {
246246
var item = results.pop();
247247
var listItem = $('<li style="display:none"></li>');
248-
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
248+
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
249249
// dirhtml builder
250250
var dirname = item[0] + '/';
251251
if (dirname.match(/\/index\/$/)) {
@@ -424,15 +424,15 @@ var Search = {
424424
for (j = 0; j < _files.length; j++) {
425425
file = _files[j];
426426
if (!(file in scoreMap))
427-
scoreMap[file] = {}
427+
scoreMap[file] = {};
428428
scoreMap[file][word] = o.score;
429429
}
430430
});
431431

432432
// create the mapping
433433
for (j = 0; j < files.length; j++) {
434434
file = files[j];
435-
if (file in fileMap)
435+
if (file in fileMap && fileMap[file].indexOf(word) === -1)
436436
fileMap[file].push(word);
437437
else
438438
fileMap[file] = [word];

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

+9-9
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99

10-
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11-
<script type="text/javascript" src="_static/jquery.js"></script>
12-
<script type="text/javascript" src="_static/underscore.js"></script>
13-
<script type="text/javascript" src="_static/doctools.js"></script>
14-
<script type="text/javascript" src="_static/language_data.js"></script>
10+
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11+
<script src="_static/jquery.js"></script>
12+
<script src="_static/underscore.js"></script>
13+
<script src="_static/doctools.js"></script>
14+
<script src="_static/language_data.js"></script>
1515

16-
<script type="text/javascript" src="_static/sidebar.js"></script>
16+
<script src="_static/sidebar.js"></script>
1717

1818
<link rel="index" title="Index" href="genindex.html" />
1919
<link rel="search" title="Search" href="search.html" />
@@ -168,7 +168,7 @@ <h3 id="searchlabel">Quick search</h3>
168168
</form>
169169
</div>
170170
</div>
171-
<script type="text/javascript">$('#searchbox').show(0);</script>
171+
<script>$('#searchbox').show(0);</script>
172172
</div>
173173
</div>
174174
<div class="clearer"></div>
@@ -189,8 +189,8 @@ <h3>Navigation</h3>
189189
</div>
190190

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

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

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
99
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1010

11-
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
12-
<script type="text/javascript" src="_static/jquery.js"></script>
13-
<script type="text/javascript" src="_static/underscore.js"></script>
14-
<script type="text/javascript" src="_static/doctools.js"></script>
15-
<script type="text/javascript" src="_static/language_data.js"></script>
11+
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
12+
<script src="_static/jquery.js"></script>
13+
<script src="_static/underscore.js"></script>
14+
<script src="_static/doctools.js"></script>
15+
<script src="_static/language_data.js"></script>
1616

17-
<script type="text/javascript" src="_static/sidebar.js"></script>
17+
<script src="_static/sidebar.js"></script>
1818

1919
<link rel="index" title="Index" href="#" />
2020
<link rel="search" title="Search" href="search.html" />
@@ -822,7 +822,7 @@ <h3 id="searchlabel">Quick search</h3>
822822
</form>
823823
</div>
824824
</div>
825-
<script type="text/javascript">$('#searchbox').show(0);</script>
825+
<script>$('#searchbox').show(0);</script>
826826
</div>
827827
</div>
828828
<div class="clearer"></div>
@@ -837,8 +837,8 @@ <h3>Navigation</h3>
837837
</div>
838838

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

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

+11-11
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99

10-
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11-
<script type="text/javascript" src="_static/jquery.js"></script>
12-
<script type="text/javascript" src="_static/underscore.js"></script>
13-
<script type="text/javascript" src="_static/doctools.js"></script>
14-
<script type="text/javascript" src="_static/language_data.js"></script>
10+
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11+
<script src="_static/jquery.js"></script>
12+
<script src="_static/underscore.js"></script>
13+
<script src="_static/doctools.js"></script>
14+
<script src="_static/language_data.js"></script>
1515

16-
<script type="text/javascript" src="_static/sidebar.js"></script>
16+
<script src="_static/sidebar.js"></script>
1717

1818
<link rel="index" title="Index" href="genindex.html" />
1919
<link rel="search" title="Search" href="search.html" />
@@ -45,7 +45,7 @@ <h1>diffpy.pdfgetx<a class="headerlink" href="#diffpy-pdfgetx" title="Permalink
4545
<p>User manual for PDFgetX3, PDFgetN3, PDFgetS3 and Python package diffpy.pdfgetx.</p>
4646
<div class="line-block">
4747
<div class="line">Release 2.1.0</div>
48-
<div class="line">December 03, 2019</div>
48+
<div class="line">July 15, 2020</div>
4949
</div>
5050
<div class="section" id="table-of-contents">
5151
<h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
@@ -100,7 +100,7 @@ <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Perm
100100
</ul>
101101
</li>
102102
<li class="toctree-l1"><a class="reference internal" href="release.html">Release notes</a><ul>
103-
<li class="toctree-l2"><a class="reference internal" href="release.html#version-2-1-0-2019-12-03">Version 2.1.0 – 2019-12-03</a></li>
103+
<li class="toctree-l2"><a class="reference internal" href="release.html#version-2-1-0-2020-07-15">Version 2.1.0 – 2020-07-15</a></li>
104104
<li class="toctree-l2"><a class="reference internal" href="release.html#version-2-0-0-2018-11-02">Version 2.0.0 – 2018-11-02</a></li>
105105
<li class="toctree-l2"><a class="reference internal" href="release.html#version-1-2-2018-01-12">Version 1.2 – 2018-01-12</a></li>
106106
</ul>
@@ -154,7 +154,7 @@ <h3 id="searchlabel">Quick search</h3>
154154
</form>
155155
</div>
156156
</div>
157-
<script type="text/javascript">$('#searchbox').show(0);</script>
157+
<script>$('#searchbox').show(0);</script>
158158
</div>
159159
</div>
160160
<div class="clearer"></div>
@@ -172,8 +172,8 @@ <h3>Navigation</h3>
172172
</div>
173173

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

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

+10-10
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99

10-
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11-
<script type="text/javascript" src="_static/jquery.js"></script>
12-
<script type="text/javascript" src="_static/underscore.js"></script>
13-
<script type="text/javascript" src="_static/doctools.js"></script>
14-
<script type="text/javascript" src="_static/language_data.js"></script>
10+
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
11+
<script src="_static/jquery.js"></script>
12+
<script src="_static/underscore.js"></script>
13+
<script src="_static/doctools.js"></script>
14+
<script src="_static/language_data.js"></script>
1515

16-
<script type="text/javascript" src="_static/sidebar.js"></script>
16+
<script src="_static/sidebar.js"></script>
1717

1818
<link rel="index" title="Index" href="genindex.html" />
1919
<link rel="search" title="Search" href="search.html" />
@@ -46,7 +46,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
4646
<div class="section" id="software-requirements">
4747
<h2>Software requirements<a class="headerlink" href="#software-requirements" title="Permalink to this headline"></a></h2>
4848
<p>This software is written in Python programming language, therefore
49-
you must have Python 3.7, 3.6, 3.5, 3.4 or 2.7 installed. In addition,
49+
you must have Python 3.7, 3.6, 3.5 or 2.7 installed. In addition,
5050
the following third-party Python libraries are also required:</p>
5151
<ul class="simple">
5252
<li><p>pip - Python package installer</p></li>
@@ -207,7 +207,7 @@ <h3 id="searchlabel">Quick search</h3>
207207
</form>
208208
</div>
209209
</div>
210-
<script type="text/javascript">$('#searchbox').show(0);</script>
210+
<script>$('#searchbox').show(0);</script>
211211
</div>
212212
</div>
213213
<div class="clearer"></div>
@@ -228,8 +228,8 @@ <h3>Navigation</h3>
228228
</div>
229229

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

0 commit comments

Comments
 (0)