Skip to content

Commit 1e9dacc

Browse files
mkhortonmkhorton
committed
Updated docs build
1 parent 4b238c2 commit 1e9dacc

File tree

125 files changed

+5042
-16117
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

125 files changed

+5042
-16117
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: e871c5c5f1a1bd6458903dc430b8015f
3+
config: 7fb58f2e59309da3d5bf0e68e0b06635
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/CNAME‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
docs.crystaltoolkit.org
1+
docs.crystaltoolkit.org

‎docs/_modules/crystal_toolkit.html‎

Lines changed: 38 additions & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,41 @@
1-
2-
31
<!DOCTYPE html>
42
<html class="writer-html5" lang="en" >
53
<head>
64
<meta charset="utf-8" />
7-
85
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
106
<title>crystal_toolkit &mdash; Crystal Toolkit documentation</title>
11-
12-
13-
14-
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
15-
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
16-
17-
18-
19-
20-
21-
7+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
8+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
229
<link rel="canonical" href="https://crystaltoolkit.org_modules/crystal_toolkit.html"/>
23-
24-
25-
26-
27-
2810
<!--[if lt IE 9]>
2911
<script src="../_static/js/html5shiv.min.js"></script>
3012
<![endif]-->
3113

32-
33-
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
14+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
3415
<script src="../_static/jquery.js"></script>
3516
<script src="../_static/underscore.js"></script>
17+
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
3618
<script src="../_static/doctools.js"></script>
37-
38-
<script type="text/javascript" src="../_static/js/theme.js"></script>
39-
40-
19+
<script src="../_static/js/theme.js"></script>
4120
<link rel="index" title="Index" href="../genindex.html" />
4221
<link rel="search" title="Search" href="../search.html" />
4322
</head>
4423

45-
<body class="wy-body-for-nav">
46-
47-
24+
<body class="wy-body-for-nav">
4825
<div class="wy-grid-for-nav">
49-
5026
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
5127
<div class="wy-side-scroll">
5228
<div class="wy-side-nav-search" style="background: linear-gradient(0deg, rgba(23,162,135,1) 0%, rgba(0,192,136,1) 100%)" >
53-
54-
55-
5629
<a href="../index.html" class="icon icon-home"> Crystal Toolkit
57-
58-
59-
6030
</a>
61-
62-
63-
64-
65-
66-
67-
6831
<div role="search">
6932
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
7033
<input type="text" name="q" placeholder="Search docs" />
7134
<input type="hidden" name="check_keywords" value="yes" />
7235
<input type="hidden" name="area" value="default" />
7336
</form>
7437
</div>
75-
76-
77-
</div>
78-
79-
80-
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
81-
82-
83-
84-
85-
86-
38+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
8739
<ul>
8840
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
8941
<li class="toctree-l1"><a class="reference external" href="https://next-gen.materialsproject.org/toolkit">Try The App!</a></li>
@@ -96,81 +48,54 @@
9648
<li class="toctree-l1"><a class="reference internal" href="../source/crystal_toolkit.html">API Docs</a></li>
9749
</ul>
9850

99-
100-
10151
</div>
102-
10352
</div>
10453
</nav>
10554

106-
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
107-
108-
109-
<nav class="wy-nav-top" aria-label="top navigation">
110-
55+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: linear-gradient(0deg, rgba(23,162,135,1) 0%, rgba(0,192,136,1) 100%)" >
11156
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
11257
<a href="../index.html">Crystal Toolkit</a>
113-
11458
</nav>
11559

116-
11760
<div class="wy-nav-content">
118-
11961
<div class="rst-content style-external-links">
120-
121-
122-
123-
124-
125-
126-
127-
128-
129-
130-
131-
132-
133-
134-
135-
136-
137-
138-
139-
<div role="navigation" aria-label="breadcrumbs navigation">
140-
62+
<div role="navigation" aria-label="Page navigation">
14163
<ul class="wy-breadcrumbs">
142-
14364
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
144-
14565
<li><a href="index.html">Module code</a> &raquo;</li>
146-
14766
<li>crystal_toolkit</li>
148-
149-
15067
<li class="wy-breadcrumbs-aside">
151-
15268
</li>
153-
15469
</ul>
155-
156-
15770
<hr/>
15871
</div>
15972
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
16073
<div itemprop="articleBody">
161-
74+
16275
<h1>Source code for crystal_toolkit</h1><div class="highlight"><pre>
163-
<span></span><span class="kn">import</span> <span class="nn">json</span>
76+
<span></span><span class="kn">from</span> <span class="nn">__future__</span> <span class="kn">import</span> <span class="n">annotations</span>
77+
78+
<span class="kn">import</span> <span class="nn">json</span>
16479
<span class="kn">import</span> <span class="nn">os</span> <span class="k">as</span> <span class="nn">_os</span>
16580
<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">defaultdict</span>
16681
<span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
82+
<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
16783

16884
<span class="c1"># pleasant hack to support MSONable objects in Dash callbacks natively</span>
16985
<span class="kn">from</span> <span class="nn">monty.json</span> <span class="kn">import</span> <span class="n">MSONable</span>
17086

171-
<span class="kn">from</span> <span class="nn">crystal_toolkit.renderables</span> <span class="kn">import</span> <span class="o">*</span>
87+
<span class="kn">from</span> <span class="nn">crystal_toolkit.renderables</span> <span class="kn">import</span> <span class="p">(</span>
88+
<span class="n">Lattice</span><span class="p">,</span>
89+
<span class="n">Molecule</span><span class="p">,</span>
90+
<span class="n">MoleculeGraph</span><span class="p">,</span>
91+
<span class="n">PhaseDiagram</span><span class="p">,</span>
92+
<span class="n">Site</span><span class="p">,</span>
93+
<span class="n">Structure</span><span class="p">,</span>
94+
<span class="n">StructureGraph</span><span class="p">,</span>
95+
<span class="n">VolumetricData</span><span class="p">,</span>
96+
<span class="p">)</span>
17297

173-
<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;2022.04.19&quot;</span>
98+
<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;2022.08.19&quot;</span>
17499

175100
<span class="n">MODULE_PATH</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parents</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
176101

@@ -183,7 +108,7 @@ <h1>Source code for crystal_toolkit</h1><div class="highlight"><pre>
183108

184109

185110
<span class="c1"># Populate the default values from the JSON file</span>
186-
<span class="n">_DEFAULTS</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="kc">None</span><span class="p">)</span>
111+
<span class="n">_DEFAULTS</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">()</span>
187112
<span class="n">default_js</span> <span class="o">=</span> <span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span>
188113
<span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">_os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="vm">__file__</span><span class="p">))),</span> <span class="s2">&quot;./&quot;</span><span class="p">,</span> <span class="s2">&quot;defaults.json&quot;</span>
189114
<span class="p">)</span>
@@ -205,8 +130,8 @@ <h1>Source code for crystal_toolkit</h1><div class="highlight"><pre>
205130
<span class="s2">This only works in Jupyter Lab 3.x or above.</span><span class="se">\n\n</span><span class="s2"></span>
206131
<span class="s2">&quot;&quot;&quot;</span>
207132

208-
<span class="n">help_text_plotly</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;If you see this text, the Plotly Jupyter Lab extension </span>
209-
<span class="s2">is not installed, please consult Plotly documentation for information on how to </span>
133+
<span class="n">help_text_plotly</span> <span class="o">=</span> <span class="s2">&quot;&quot;&quot;If you see this text, the Plotly Jupyter Lab extension</span>
134+
<span class="s2">is not installed, please consult Plotly documentation for information on how to</span>
210135
<span class="s2">install.</span>
211136
<span class="s2">&quot;&quot;&quot;</span>
212137

@@ -218,15 +143,15 @@ <h1>Source code for crystal_toolkit</h1><div class="highlight"><pre>
218143
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;get_scene&quot;</span><span class="p">):</span>
219144
<span class="k">return</span> <span class="p">{</span>
220145
<span class="s2">&quot;application/vnd.mp.ctk+json&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_scene</span><span class="p">()</span><span class="o">.</span><span class="n">to_json</span><span class="p">(),</span>
221-
<span class="s2">&quot;text/plain&quot;</span><span class="p">:</span> <span class="n">help_text_ct</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__repr__</span><span class="p">(),</span>
146+
<span class="s2">&quot;text/plain&quot;</span><span class="p">:</span> <span class="n">help_text_ct</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
222147
<span class="p">}</span>
223148
<span class="k">elif</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;get_plot&quot;</span><span class="p">):</span>
224149
<span class="k">return</span> <span class="p">{</span>
225150
<span class="s2">&quot;application/vnd.plotly.v1+json&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_plot</span><span class="p">()</span><span class="o">.</span><span class="n">to_plotly_json</span><span class="p">(),</span>
226-
<span class="s2">&quot;text/plain&quot;</span><span class="p">:</span> <span class="n">help_text_plotly</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__repr__</span><span class="p">(),</span>
151+
<span class="s2">&quot;text/plain&quot;</span><span class="p">:</span> <span class="n">help_text_plotly</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="p">),</span>
227152
<span class="p">}</span>
228153
<span class="k">else</span><span class="p">:</span>
229-
<span class="k">return</span> <span class="p">{</span><span class="s2">&quot;application/json&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">as_dict</span><span class="p">(),</span> <span class="s2">&quot;text/plain&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="fm">__repr__</span><span class="p">()}</span>
154+
<span class="k">return</span> <span class="p">{</span><span class="s2">&quot;application/json&quot;</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">as_dict</span><span class="p">(),</span> <span class="s2">&quot;text/plain&quot;</span><span class="p">:</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="p">)}</span>
230155

231156

232157
<span class="n">MSONable</span><span class="o">.</span><span class="n">_repr_mimebundle_</span> <span class="o">=</span> <span class="n">_repr_mimebundle_</span>
@@ -257,46 +182,30 @@ <h1>Source code for crystal_toolkit</h1><div class="highlight"><pre>
257182
</pre></div>
258183

259184
</div>
260-
261185
</div>
262186
<footer>
263187

264188
<hr/>
265189

266190
<div role="contentinfo">
267-
<p>
268-
&#169; Copyright 2019, Crystal Toolkit Development Team.
269-
270-
</p>
191+
<p>&#169; Copyright 2019, Crystal Toolkit Development Team.</p>
271192
</div>
272-
273-
274-
275-
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
276-
193+
194+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
277195
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
278-
279-
provided by <a href="https://readthedocs.org">Read the Docs</a>.
196+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
197+
280198

281199
</footer>
282200
</div>
283201
</div>
284-
285202
</section>
286-
287203
</div>
288-
289-
290-
<script type="text/javascript">
204+
<script>
291205
jQuery(function () {
292206
SphinxRtdTheme.Navigation.enable(true);
293207
});
294-
</script>
295-
296-
297-
298-
299-
208+
</script>
300209

301210
</body>
302211
</html>

0 commit comments

Comments
 (0)