-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
263 lines (236 loc) · 14.5 KB
/
docs.html
File metadata and controls
263 lines (236 loc) · 14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentation — 3.2.0+3.gb2780d4a</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/style.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="canonical" href="https://podpac.org/docs.html" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Development Roadmap" href="roadmap.html" />
<link rel="prev" title="Contributing" href="contributing.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html">
<img src="_static/icon.svg" class="logo" alt="Logo"/>
</a>
<div class="version">
3.2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting Started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="settings.html">Settings</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws.html">AWS Integration</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="why-podpac.html">Why PODPAC?</a></li>
<li class="toctree-l1"><a class="reference internal" href="design.html">Design</a></li>
<li class="toctree-l1"><a class="reference internal" href="dependencies.html">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="nodes.html">Nodes</a></li>
<li class="toctree-l1"><a class="reference internal" href="coordinates.html">Coordinates</a></li>
<li class="toctree-l1"><a class="reference internal" href="cache.html">Cache</a></li>
<li class="toctree-l1"><a class="reference internal" href="datasets.html">Supported Datasets</a></li>
<li class="toctree-l1"><a class="reference internal" href="interpolation.html">Interpolation</a></li>
<li class="toctree-l1"><a class="reference internal" href="earthdata.html">NASA Earth Data Login</a></li>
<li class="toctree-l1"><a class="reference internal" href="aws-development.html">AWS Development</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="wrapping-datasets.html">Wrapping Datasets</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Support</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="references.html">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#install">Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="#test">Test</a></li>
<li class="toctree-l2"><a class="reference internal" href="#build">Build</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#website">Website</a></li>
<li class="toctree-l3"><a class="reference internal" href="#pdf">PDF</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#develop">Develop</a></li>
<li class="toctree-l2"><a class="reference internal" href="#organization">Organization</a></li>
<li class="toctree-l2"><a class="reference internal" href="#references">References</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Development Roadmap</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">PODPAC</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/docs.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="documentation">
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this heading"></a></h1>
<p>The following sections outlines how to develop and build the <code class="docutils literal notranslate"><span class="pre">podpac</span></code> documentation.</p>
<section id="install">
<h2>Install<a class="headerlink" href="#install" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p>Install <strong>Sphinx</strong> and the <strong>Read the Docs</strong> theme</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install sphinx
$ pip install sphinx_rtd_theme
</pre></div>
</div>
<ul class="simple">
<li><p>Install <code class="docutils literal notranslate"><span class="pre">myst-parser</span></code> to support markdown input files</p></li>
</ul>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install myst-parser
</pre></div>
</div>
</section>
<section id="test">
<h2>Test<a class="headerlink" href="#test" title="Permalink to this heading"></a></h2>
<p>To run the doctests in the documentation, run from the <code class="docutils literal notranslate"><span class="pre">/doc</span></code> directory:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ./test-docs.sh <span class="c1"># convienence script</span>
<span class="c1"># or</span>
$ sphinx-build -b doctest <span class="nb">source</span> build <span class="c1"># run tests manually</span>
</pre></div>
</div>
</section>
<section id="build">
<h2>Build<a class="headerlink" href="#build" title="Permalink to this heading"></a></h2>
<section id="website">
<h3>Website<a class="headerlink" href="#website" title="Permalink to this heading"></a></h3>
<p>To build the documentation into a website in the <code class="docutils literal notranslate"><span class="pre">doc/build</span></code> directory, run from the <code class="docutils literal notranslate"><span class="pre">/doc</span></code> directory:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ./release-docs.sh <span class="c1"># convienence script</span>
<span class="c1"># or</span>
$ sphinx-build <span class="nb">source</span> build <span class="c1"># run manually</span>
$ sphinx-build -aE <span class="nb">source</span> build <span class="c1"># rebuild all files (no cache)</span>
</pre></div>
</div>
<p>See <a class="reference external" href="http://www.sphinx-doc.org/en/stable/invocation.html#invocation-of-sphinx-build"><code class="docutils literal notranslate"><span class="pre">sphinx-build</span></code> docs</a> for more options.</p>
</section>
<section id="pdf">
<h3>PDF<a class="headerlink" href="#pdf" title="Permalink to this heading"></a></h3>
<p>To build a pdf from the documentation, you need to install a latex distribution (<a class="reference external" href="https://miktex.org">MikTex (Windows)</a> <a class="reference external" href="https://www.tug.org/mactex/">MacTex (Mac)</a>), then run:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make latex <span class="c1"># build the docs into a tex format in a latex directory</span>
<span class="c1"># or</span>
$ sphinx-build -b latex <span class="nb">source</span> latex <span class="c1"># run sphinx manually to build latex</span>
</pre></div>
</div>
<p>Enter the build directory and convert tex file to pdf:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="nb">cd</span> build <span class="c1"># go into the latex directory</span>
$ pdflatex podpac.tex <span class="c1"># build the pdf from podpac.tex entry file</span>
</pre></div>
</div>
</section>
</section>
<section id="develop">
<h2>Develop<a class="headerlink" href="#develop" title="Permalink to this heading"></a></h2>
<p>To live-serve the documentation as a website during development, you will need to add one more python package <a class="reference external" href="https://github.com/GaretJax/sphinx-autobuild"><code class="docutils literal notranslate"><span class="pre">sphinx-autobuild</span></code></a>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install sphinx-autobuild
</pre></div>
</div>
<p>Then run from the <code class="docutils literal notranslate"><span class="pre">doc</span></code> directory:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ ./serve-docs.sh <span class="c1"># convienence script</span>
<span class="c1"># or</span>
$ sphinx-autobuild <span class="nb">source</span> build <span class="c1"># run manually</span>
$ sphinx-autobuild -aE <span class="nb">source</span> build <span class="c1"># rebuild all files (no cache)</span>
</pre></div>
</div>
<p>And the visit the webpage served at <code class="docutils literal notranslate"><span class="pre">http://127.0.0.1:8000</span></code>. Each time a change to the documentation source is detected, the HTML is rebuilt and the browser automatically reloaded.</p>
<p>To stop the server simply press <code class="docutils literal notranslate"><span class="pre">^C</span></code>.</p>
</section>
<section id="organization">
<h2>Organization<a class="headerlink" href="#organization" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">/source</span></code> - source documentation files</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">/source/_templates</span></code> - templates to use for styling pages</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/source/_static</span></code> - static files that need to be copied over to distributed documentation (i.e. images, source code, etc)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/source/conf.py</span></code> - sphinx configuration file</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/source/index.rst</span></code> - root documentation file</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">/source/api/</span></code> - auto generated API documentation using <code class="docutils literal notranslate"><span class="pre">sphinx-autogen</span></code></p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">/build</span></code> - generated documentation files</p></li>
</ul>
</section>
<section id="references">
<h2>References<a class="headerlink" href="#references" title="Permalink to this heading"></a></h2>
<ul class="simple">
<li><p><a class="reference external" href="http://www.sphinx-doc.org/en/stable/ext/autodoc.html#module-sphinx.ext.autodoc">Sphinx docstring interpretation (autodoc)</a></p></li>
<li><p><a class="reference external" href="http://www.sphinx-doc.org/en/stable/theming.html">Sphinx Themes</a></p>
<ul>
<li><p><a class="reference external" href="https://github.com/rtfd/sphinx_rtd_theme">Read the Docs Theme</a></p></li>
</ul>
</li>
<li><p><a class="reference external" href="http://www.sphinx-doc.org/en/master/ext/doctest.html">Sphinx doctest</a></p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="contributing.html" class="btn btn-neutral float-left" title="Contributing" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="roadmap.html" class="btn btn-neutral float-right" title="Development Roadmap" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2017-2023, Creare.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using 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>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>