Update dev docs

materialsproject · Mar 28, 2019 · c327127 · c327127
1 parent 161330d
commit c327127
Show file tree

Hide file tree

Showing 47 changed files with 491 additions and 2,453 deletions.
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -4,15 +4,16 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-        <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>Overview: module code &#8212; pymatgen-db 2018.2.21 documentation</title>
+    <title>Overview: module code &#8212; pymatgen-db 2019.3.28 documentation</title>
     <link rel="stylesheet" href="../_static/flasky.css" type="text/css" />
     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script type="text/javascript" src="../_static/documentation_options.js"></script>
+    <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>
     <link rel="shortcut icon" href="../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
@@ -38,7 +39,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../index.html">pymatgen-db 2018.2.21 documentation</a> &#187;</li> 
+        <li class="nav-item nav-item-0"><a href="../index.html">pymatgen-db 2019.3.28 documentation</a> &#187;</li> 
       </ul>
     </div>  
 
@@ -48,14 +49,9 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <h1>All modules for which code is available</h1>
-<ul><li><a href="matgendb/alchemy/transmuters.html">matgendb.alchemy.transmuters</a></li>
-<li><a href="matgendb/builders/examples/copy_builder.html">matgendb.builders.examples.copy_builder</a></li>
+<ul><li><a href="matgendb/builders/examples/copy_builder.html">matgendb.builders.examples.copy_builder</a></li>
 <li><a href="matgendb/builders/examples/file_builders.html">matgendb.builders.examples.file_builders</a></li>
 <li><a href="matgendb/builders/examples/maxvalue_builder.html">matgendb.builders.examples.maxvalue_builder</a></li>
-<li><a href="matgendb/vv/diff.html">matgendb.vv.diff</a></li>
-<li><a href="matgendb/vv/report.html">matgendb.vv.report</a></li>
-<li><a href="matgendb/vv/util.html">matgendb.vv.util</a></li>
-<li><a href="matgendb/vv/validate.html">matgendb.vv.validate</a></li>
 </ul>
 
           </div>

diff --git a/docs/_modules/matgendb/builders/examples/copy_builder.html b/docs/_modules/matgendb/builders/examples/copy_builder.html
@@ -4,15 +4,16 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-        <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>matgendb.builders.examples.copy_builder &#8212; pymatgen-db 2018.2.21 documentation</title>
+    <title>matgendb.builders.examples.copy_builder &#8212; pymatgen-db 2019.3.28 documentation</title>
     <link rel="stylesheet" href="../../../../_static/flasky.css" type="text/css" />
     <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
-    <script type="text/javascript" src="../../../../_static/documentation_options.js"></script>
+    <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>
     <link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
@@ -38,7 +39,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-db 2018.2.21 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-db 2019.3.28 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  

diff --git a/docs/_modules/matgendb/builders/examples/file_builders.html b/docs/_modules/matgendb/builders/examples/file_builders.html
@@ -4,15 +4,16 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-        <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>matgendb.builders.examples.file_builders &#8212; pymatgen-db 2018.2.21 documentation</title>
+    <title>matgendb.builders.examples.file_builders &#8212; pymatgen-db 2019.3.28 documentation</title>
     <link rel="stylesheet" href="../../../../_static/flasky.css" type="text/css" />
     <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
-    <script type="text/javascript" src="../../../../_static/documentation_options.js"></script>
+    <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>
     <link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
@@ -38,7 +39,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-db 2018.2.21 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-db 2019.3.28 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  

diff --git a/docs/_modules/matgendb/builders/examples/maxvalue_builder.html b/docs/_modules/matgendb/builders/examples/maxvalue_builder.html
@@ -4,15 +4,16 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-        <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
+    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-    <title>matgendb.builders.examples.maxvalue_builder &#8212; pymatgen-db 2018.2.21 documentation</title>
+    <title>matgendb.builders.examples.maxvalue_builder &#8212; pymatgen-db 2019.3.28 documentation</title>
     <link rel="stylesheet" href="../../../../_static/flasky.css" type="text/css" />
     <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
-    <script type="text/javascript" src="../../../../_static/documentation_options.js"></script>
+    <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>
     <link rel="shortcut icon" href="../../../../_static/favicon.ico"/>
     <link rel="index" title="Index" href="../../../../genindex.html" />
     <link rel="search" title="Search" href="../../../../search.html" />
@@ -38,7 +39,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="../../../../py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-db 2018.2.21 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="../../../../index.html">pymatgen-db 2019.3.28 documentation</a> &#187;</li>
           <li class="nav-item nav-item-1"><a href="../../../index.html" accesskey="U">Module code</a> &#187;</li> 
       </ul>
     </div>  

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -21,6 +21,11 @@ Other pages
 Change Log
 ==========
 
+v2018.3.28
+----------
+1. Improved handling of nested db dicts. (Donny Winston)
+
+
 v2018.2.21
 ----------
 1. Fix --tag option in mgdb to support multiple tags.

diff --git a/docs/_sources/matgendb.alchemy.rst.txt b/docs/_sources/matgendb.alchemy.rst.txt
@@ -1,22 +1,3 @@
 matgendb.alchemy package
 ========================
 
-Submodules
-----------
-
-matgendb.alchemy.transmuters module
------------------------------------
-
-.. automodule:: matgendb.alchemy.transmuters
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: matgendb.alchemy
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/_sources/matgendb.vv.rst.txt b/docs/_sources/matgendb.vv.rst.txt
@@ -1,46 +1,3 @@
 matgendb.vv package
 ===================
 
-Submodules
-----------
-
-matgendb.vv.diff module
------------------------
-
-.. automodule:: matgendb.vv.diff
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-matgendb.vv.report module
--------------------------
-
-.. automodule:: matgendb.vv.report
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-matgendb.vv.util module
------------------------
-
-.. automodule:: matgendb.vv.util
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-matgendb.vv.validate module
----------------------------
-
-.. automodule:: matgendb.vv.validate
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: matgendb.vv
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/_static/basic.css b/docs/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -81,6 +81,10 @@ div.sphinxsidebar input {
     font-size: 1em;
 }
 
+div.sphinxsidebar #searchbox form.search {
+    overflow: hidden;
+}
+
 div.sphinxsidebar #searchbox input[type="text"] {
     float: left;
     width: 80%;
@@ -427,6 +431,13 @@ table.field-list td, table.field-list th {
     hyphens: manual;
 }
 
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist td {
+    vertical-align: top;
+}
+
+
 /* -- other body styles ----------------------------------------------------- */
 
 ol.arabic {

diff --git a/docs/_static/doctools.js b/docs/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -70,7 +70,9 @@ jQuery.fn.highlightText = function(text, className) {
     if (node.nodeType === 3) {
       var val = node.nodeValue;
       var pos = val.toLowerCase().indexOf(text);
-      if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
+      if (pos >= 0 &&
+          !jQuery(node.parentNode).hasClass(className) &&
+          !jQuery(node.parentNode).hasClass("nohighlight")) {
         var span;
         var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
         if (isInSVG) {
@@ -148,7 +150,9 @@ var Documentation = {
     this.fixFirefoxAnchorBug();
     this.highlightSearchWords();
     this.initIndexTable();
-
+    if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
+      this.initOnKeyListeners();
+    }
   },
 
   /**
@@ -308,4 +312,4 @@ _ = Documentation.gettext;
 
 $(document).ready(function() {
   Documentation.init();
-});
+});
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,9 +1,10 @@
 var DOCUMENTATION_OPTIONS = {
-    URL_ROOT: '',
-    VERSION: '2018.2.21',
+    URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+    VERSION: '2019.3.28',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',
     HAS_SOURCE: true,
-    SOURCELINK_SUFFIX: '.txt'
+    SOURCELINK_SUFFIX: '.txt',
+    NAVIGATION_WITH_KEYS: false,
 };