Skip to content

DOC: add updated pdfgetx v2.1.0 user manual to source #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 17, 2020
Merged

DOC: add updated pdfgetx v2.1.0 user manual to source #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
DOC: add updated pdfgetx v2.1.0 user manual to source
  • Loading branch information
tienhungvuong committed Jul 16, 2020
commit cee3f198349129bc84d196fa727147f9583b923e
Binary file modified static_root/doc/pdfgetx/2.1.0/PDFgetXNS3_manual.pdf
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion static_root/doc/pdfgetx/2.1.0/_sources/install.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Software requirements
------------------------------------------------------------------------

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

* pip - Python package installer
Expand Down
2 changes: 2 additions & 0 deletions static_root/doc/pdfgetx/2.1.0/_sources/intro.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Timur Davis,
Chia-Hao (Timothy) Liu,
Christopher Wright,
Christopher Farrow,
Hung Vuong,
Songsheng Tao,
Simon Billinge.


Expand Down
6 changes: 5 additions & 1 deletion static_root/doc/pdfgetx/2.1.0/_static/basic.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -672,6 +672,10 @@ div.code-block-caption + div > div.highlight > pre {
margin-top: 0;
}

div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}

div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
Expand Down
2 changes: 1 addition & 1 deletion static_root/doc/pdfgetx/2.1.0/_static/classic.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- classic theme.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
7 changes: 4 additions & 3 deletions static_root/doc/pdfgetx/2.1.0/_static/doctools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -283,10 +283,11 @@ var Documentation = {
},

initOnKeyListeners: function() {
$(document).keyup(function(event) {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
Expand Down
1 change: 1 addition & 0 deletions static_root/doc/pdfgetx/2.1.0/_static/documentation_options.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ var DOCUMENTATION_OPTIONS = {
VERSION: '2.1.0',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
Expand Down
2 changes: 1 addition & 1 deletion static_root/doc/pdfgetx/2.1.0/_static/language_data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
8 changes: 4 additions & 4 deletions static_root/doc/pdfgetx/2.1.0/_static/searchtools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -245,7 +245,7 @@ var Search = {
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
Expand Down Expand Up @@ -424,15 +424,15 @@ var Search = {
for (j = 0; j < _files.length; j++) {
file = _files[j];
if (!(file in scoreMap))
scoreMap[file] = {}
scoreMap[file] = {};
scoreMap[file][word] = o.score;
}
});

// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
if (file in fileMap)
if (file in fileMap && fileMap[file].indexOf(word) === -1)
fileMap[file].push(word);
else
fileMap[file] = [word];
Expand Down
18 changes: 9 additions & 9 deletions static_root/doc/pdfgetx/2.1.0/files.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/sidebar.js"></script>
<script src="_static/sidebar.js"></script>

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -168,7 +168,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
Expand All @@ -189,8 +189,8 @@ <h3>Navigation</h3>
</div>

<div class="footer" role="contentinfo">
&#169; Copyright 2019, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.1.
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
</div>
</body>
</html>
18 changes: 9 additions & 9 deletions static_root/doc/pdfgetx/2.1.0/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/sidebar.js"></script>
<script src="_static/sidebar.js"></script>

<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -822,7 +822,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
Expand All @@ -837,8 +837,8 @@ <h3>Navigation</h3>
</div>

<div class="footer" role="contentinfo">
&#169; Copyright 2019, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.1.
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
</div>
</body>
</html>
22 changes: 11 additions & 11 deletions static_root/doc/pdfgetx/2.1.0/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/sidebar.js"></script>
<script src="_static/sidebar.js"></script>

<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -45,7 +45,7 @@ <h1>diffpy.pdfgetx<a class="headerlink" href="#diffpy-pdfgetx" title="Permalink
<p>User manual for PDFgetX3, PDFgetN3, PDFgetS3 and Python package diffpy.pdfgetx.</p>
<div class="line-block">
<div class="line">Release 2.1.0</div>
<div class="line">December 03, 2019</div>
<div class="line">July 15, 2020</div>
</div>
<div class="section" id="table-of-contents">
<h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h2>
Expand Down Expand Up @@ -100,7 +100,7 @@ <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Perm
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release.html">Release notes</a><ul>
<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>
<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>
<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>
<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>
</ul>
Expand Down Expand Up @@ -154,7 +154,7 @@ <h3 id="searchlabel">Quick search</h3>
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
Expand All @@ -172,8 +172,8 @@ <h3>Navigation</h3>
</div>

<div class="footer" role="contentinfo">
&#169; Copyright 2019, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.2.1.
&#169; Copyright 2020, Pavol Juhás, Timur Davis, Chia-Hao (Timothy) Liu, Christopher Wright, Christopher Farrow, Simon Billinge.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.0.
</div>
</body>
</html>
20 changes: 10 additions & 10 deletions static_root/doc/pdfgetx/2.1.0/install.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
<link rel="stylesheet" href="_static/pydoctheme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></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>
<script type="text/javascript" src="_static/language_data.js"></script>
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/sidebar.js"></script>
<script src="_static/sidebar.js"></script>

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

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