Skip to content

Commit

Permalink
Update docs. Fixes #2079
Browse files Browse the repository at this point in the history
  • Loading branch information
@shyuep
shyuep committed Mar 1, 2021
1 parent ccd0431 commit 0faaa55
Show file tree
Hide file tree
Showing 291 changed files with 9,350 additions and 8,435 deletions.
7 changes: 1 addition & 6 deletions docs/_static/doctools.js
View file
Expand Up @@ -29,14 +29,9 @@ if (!window.console || !console.firebug) {

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
return decodeURIComponent(x).replace(/\+/g, ' ');
};

/**
Expand Down
4 changes: 2 additions & 2 deletions docs/_static/language_data.js
View file
Expand Up @@ -13,8 +13,7 @@
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];


/* Non-minified version is copied as a separate JS file, is available */

/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
Expand Down Expand Up @@ -200,6 +199,7 @@ var Stemmer = function() {




var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
Expand Down
6 changes: 3 additions & 3 deletions docs/_static/pygments.css
View file
@@ -1,7 +1,7 @@
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; }
td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #eeffcc; }
Expand Down
26 changes: 9 additions & 17 deletions docs/_static/searchtools.js
View file
Expand Up @@ -248,7 +248,7 @@ var Search = {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li></li>');
var listItem = $('<li style="display:none"></li>');
var requestUrl = "";
var linkUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
Expand All @@ -273,9 +273,9 @@ var Search = {
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
setTimeout(function() {
listItem.slideDown(5, function() {
displayNextItem();
}, 5);
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: requestUrl,
dataType: "text",
Expand All @@ -285,16 +285,16 @@ var Search = {
listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
}
Search.output.append(listItem);
setTimeout(function() {
listItem.slideDown(5, function() {
displayNextItem();
}, 5);
});
}});
} else {
// no source available, just display title
Search.output.append(listItem);
setTimeout(function() {
listItem.slideDown(5, function() {
displayNextItem();
}, 5);
});
}
}
// search finished, update title and status message
Expand Down Expand Up @@ -379,13 +379,6 @@ var Search = {
return results;
},

/**
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
*/
escapeRegExp : function(string) {
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
},

/**
* search for full-text terms in the index
*/
Expand All @@ -409,14 +402,13 @@ var Search = {
];
// add support for partial matches
if (word.length > 2) {
var word_regex = this.escapeRegExp(word);
for (var w in terms) {
if (w.match(word_regex) && !terms[word]) {
if (w.match(word) && !terms[word]) {
_o.push({files: terms[w], score: Scorer.partialTerm})
}
}
for (var w in titleterms) {
if (w.match(word_regex) && !titleterms[word]) {
if (w.match(word) && !titleterms[word]) {
_o.push({files: titleterms[w], score: Scorer.partialTitle})
}
}
Expand Down
37 changes: 31 additions & 6 deletions docs/_static/underscore.js
View file

Large diffs are not rendered by default.

23 changes: 13 additions & 10 deletions docs/change_log.html
View file
Expand Up @@ -3,9 +3,9 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta charset="utf-8" />

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Change log &mdash; pymatgen 2021.2.16 documentation</title>

Expand All @@ -17,12 +17,15 @@






<link rel="canonical" href="https://pymatgen.orgchange_log.html"/>





<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -32,6 +35,7 @@
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

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

Expand Down Expand Up @@ -60,7 +64,7 @@



<a href="index.html" class="icon icon-home" alt="Documentation Home"> pymatgen
<a href="index.html" class="icon icon-home"> pymatgen



Expand Down Expand Up @@ -414,6 +418,8 @@





<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">
Expand All @@ -425,7 +431,7 @@

<li class="wy-breadcrumbs-aside">



<a href="https://github.com/materialsproject/pymatgen/blob/master/docs_rst/change_log.rst" class="fa fa-github"> Edit on GitHub</a>

Expand Down Expand Up @@ -3028,28 +3034,25 @@ <h2>v1.6.0<a class="headerlink" href="#v1-6-0" title="Permalink to this headline

</div>
<footer>


<hr/>

<div role="contentinfo">
<p>

&copy; Copyright 2011, Pymatgen Development Team
&#169; Copyright 2011, Pymatgen Development Team.

</p>
</div>



Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

Expand Down
23 changes: 13 additions & 10 deletions docs/contributing.html
View file
Expand Up @@ -3,9 +3,9 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta charset="utf-8" />

<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />

<title>Collaborative Github Workflow &mdash; pymatgen 2021.2.16 documentation</title>

Expand All @@ -17,12 +17,15 @@






<link rel="canonical" href="https://pymatgen.orgcontributing.html"/>





<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
Expand All @@ -32,6 +35,7 @@
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

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

Expand All @@ -58,7 +62,7 @@



<a href="index.html" class="icon icon-home" alt="Documentation Home"> pymatgen
<a href="index.html" class="icon icon-home"> pymatgen



Expand Down Expand Up @@ -141,6 +145,8 @@





<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">
Expand All @@ -152,7 +158,7 @@

<li class="wy-breadcrumbs-aside">



<a href="https://github.com/materialsproject/pymatgen/blob/master/docs_rst/contributing.rst" class="fa fa-github"> Edit on GitHub</a>

Expand Down Expand Up @@ -296,28 +302,25 @@ <h2>A word on coding for Python 2 compatibility<a class="headerlink" href="#a-wo

</div>
<footer>


<hr/>

<div role="contentinfo">
<p>

&copy; Copyright 2011, Pymatgen Development Team
&#169; Copyright 2011, Pymatgen Development Team.

</p>
</div>



Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>
</div>

Expand Down

0 comments on commit 0faaa55

Please sign in to comment.