Skip to content

Commit d8e308a

Browse files
ardunnardunn
committed
update index docs
1 parent 89b90a4 commit d8e308a

16 files changed

+56
-35
lines changed

‎docs/_sources/index.rst.txt

+8
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,14 @@ Requirements
187187
Install
188188
-------
189189

190+
Pip install:
191+
192+
.. code-block:: bash
193+
194+
$ pip install rocketsled
195+
196+
Or install in dev-mode:
197+
190198
.. code-block:: bash
191199
192200
$ # Download the repository and install

‎docs/_static/documentation_options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: '',
3-
VERSION: '2018.12.30',
3+
VERSION: '2018.12.31',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
FILE_SUFFIX: '.html',

‎docs/advanced.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Advanced Tutorial - 15-20 min &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>Advanced Tutorial - 15-20 min &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -250,7 +250,7 @@ <h3>Navigation</h3>
250250
<li class="right" >
251251
<a href="py-modindex.html" title="Python Module Index"
252252
>modules</a> |</li>
253-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
253+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
254254
</ul>
255255
</div>
256256

‎docs/basic.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Basic Tutorial - 5-10 min &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>Basic Tutorial - 5-10 min &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -176,7 +176,7 @@ <h3>Navigation</h3>
176176
<li class="right" >
177177
<a href="py-modindex.html" title="Python Module Index"
178178
>modules</a> |</li>
179-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
179+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
180180
</ul>
181181
</div>
182182

‎docs/genindex.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
99
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10-
<title>Index &#8212; rocketsled 2018.12.30 documentation</title>
10+
<title>Index &#8212; rocketsled 2018.12.31 documentation</title>
1111
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1212
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1313
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
2929
<li class="right" >
3030
<a href="py-modindex.html" title="Python Module Index"
3131
>modules</a> |</li>
32-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
32+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3333
</ul>
3434
</div>
3535

@@ -429,7 +429,7 @@ <h3>Navigation</h3>
429429
<li class="right" >
430430
<a href="py-modindex.html" title="Python Module Index"
431431
>modules</a> |</li>
432-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
432+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
433433
</ul>
434434
</div>
435435

‎docs/guide.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Comprehensive Guide &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>Comprehensive Guide &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -588,7 +588,7 @@ <h3>Navigation</h3>
588588
<li class="right" >
589589
<a href="py-modindex.html" title="Python Module Index"
590590
>modules</a> |</li>
591-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
591+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
592592
</ul>
593593
</div>
594594

‎docs/index.html

+8-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>rocketsled &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>rocketsled &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="#">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="#">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -164,6 +164,11 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
164164
</div>
165165
<div class="section" id="install">
166166
<h2>Install<a class="headerlink" href="#install" title="Permalink to this headline"></a></h2>
167+
<p>Pip install:</p>
168+
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ pip install rocketsled
169+
</pre></div>
170+
</div>
171+
<p>Or install in dev-mode:</p>
167172
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ <span class="c1"># Download the repository and install</span>
168173
$ git clone https://github.com/hackingmaterials/rocketsled.git
169174
$ <span class="nb">cd</span> rocketsled
@@ -283,7 +288,7 @@ <h3>Navigation</h3>
283288
<li class="right" >
284289
<a href="py-modindex.html" title="Python Module Index"
285290
>modules</a> |</li>
286-
<li class="nav-item nav-item-0"><a href="#">rocketsled 2018.12.30 documentation</a> &#187;</li>
291+
<li class="nav-item nav-item-0"><a href="#">rocketsled 2018.12.31 documentation</a> &#187;</li>
287292
</ul>
288293
</div>
289294

‎docs/modules.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>rocketsled &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>rocketsled &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -110,7 +110,7 @@ <h3>Navigation</h3>
110110
<li class="right" >
111111
<a href="py-modindex.html" title="Python Module Index"
112112
>modules</a> |</li>
113-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
113+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
114114
</ul>
115115
</div>
116116

‎docs/objects.inv

0 Bytes
Binary file not shown.

‎docs/py-modindex.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Python Module Index &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>Python Module Index &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -31,7 +31,7 @@ <h3>Navigation</h3>
3131
<li class="right" >
3232
<a href="#" title="Python Module Index"
3333
>modules</a> |</li>
34-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
34+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3535
</ul>
3636
</div>
3737

@@ -145,7 +145,7 @@ <h3>Navigation</h3>
145145
<li class="right" >
146146
<a href="#" title="Python Module Index"
147147
>modules</a> |</li>
148-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
148+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
149149
</ul>
150150
</div>
151151

‎docs/rocketsled.examples.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>rocketsled.examples package &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>rocketsled.examples package &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -298,7 +298,7 @@ <h3>Navigation</h3>
298298
<li class="right" >
299299
<a href="py-modindex.html" title="Python Module Index"
300300
>modules</a> |</li>
301-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
301+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
302302
</ul>
303303
</div>
304304

‎docs/rocketsled.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>rocketsled package &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>rocketsled package &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -877,7 +877,7 @@ <h3>Navigation</h3>
877877
<li class="right" >
878878
<a href="py-modindex.html" title="Python Module Index"
879879
>modules</a> |</li>
880-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
880+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
881881
</ul>
882882
</div>
883883

‎docs/rocketsled.tests.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>rocketsled.tests package &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>rocketsled.tests package &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -424,7 +424,7 @@ <h3>Navigation</h3>
424424
<li class="right" >
425425
<a href="py-modindex.html" title="Python Module Index"
426426
>modules</a> |</li>
427-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
427+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
428428
</ul>
429429
</div>
430430

‎docs/search.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Search &#8212; rocketsled 2018.12.30 documentation</title>
9+
<title>Search &#8212; rocketsled 2018.12.31 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -36,7 +36,7 @@ <h3>Navigation</h3>
3636
<li class="right" >
3737
<a href="py-modindex.html" title="Python Module Index"
3838
>modules</a> |</li>
39-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
39+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
4040
</ul>
4141
</div>
4242

@@ -87,7 +87,7 @@ <h3>Navigation</h3>
8787
<li class="right" >
8888
<a href="py-modindex.html" title="Python Module Index"
8989
>modules</a> |</li>
90-
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.30 documentation</a> &#187;</li>
90+
<li class="nav-item nav-item-0"><a href="index.html">rocketsled 2018.12.31 documentation</a> &#187;</li>
9191
</ul>
9292
</div>
9393

‎docs/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs_rst/index.rst

+8
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,14 @@ Requirements
187187
Install
188188
-------
189189

190+
Pip install:
191+
192+
.. code-block:: bash
193+
194+
$ pip install rocketsled
195+
196+
Or install in dev-mode:
197+
190198
.. code-block:: bash
191199
192200
$ # Download the repository and install

0 commit comments

Comments
 (0)