Docs update

arm61 · May 16, 2018 · 3b88a8f · 3b88a8f
1 parent 34b1155
commit 3b88a8f
Show file tree

Hide file tree

Showing 9 changed files with 175 additions and 82 deletions.
diff --git a/docs/README.rst b/docs/README.rst
@@ -15,19 +15,3 @@ how to cite pylj
 ----------------
 Thank you for using pylj. If you use this code in a teaching laboratory or a publication we would greatly appreciate if you would use the following citation.
 Andrew R. McCluskey, Benjamin J. Morgan, Karen J. Edler, Stephen C. Parker (2018). pylj, version 0.0.6a. Released: 2018-05-15, DOI: 10.5281/zenodo.1212792. 
-
-how do i get pylj?
-------------------
-
-If you are interested in using pylj, in any sense, fork the code at http://www.github.com/arm61/pylj or email Andrew (arm61 'at' bath.ac.uk). We are currently investigating the feasibility of hosting a freely available test instance on Amazon Web Services.
-
-requirements
-------------
-To run pylj locally it is necessary to have:
-
-- python 3
-- numpy
-- matplotlib
-- cython
-- C++ complier
-
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/html/_modules/pylj/sample.html b/docs/build/html/_modules/pylj/sample.html
diff --git a/docs/build/html/index.html b/docs/build/html/index.html
@@ -66,21 +66,6 @@ <h2>how to cite pylj<a class="headerlink" href="#how-to-cite-pylj" title="Permal
 <p>Thank you for using pylj. If you use this code in a teaching laboratory or a publication we would greatly appreciate if you would use the following citation.
 Andrew R. McCluskey, Benjamin J. Morgan, Karen J. Edler, Stephen C. Parker (2018). pylj, version 0.0.6a. Released: 2018-05-15, DOI: 10.5281/zenodo.1212792.</p>
 </div>
-<div class="section" id="how-do-i-get-pylj">
-<h2>how do i get pylj?<a class="headerlink" href="#how-do-i-get-pylj" title="Permalink to this headline">¶</a></h2>
-<p>If you are interested in using pylj, in any sense, fork the code at <a class="reference external" href="http://www.github.com/arm61/pylj">http://www.github.com/arm61/pylj</a> or email Andrew (arm61 ‘at’ bath.ac.uk). We are currently investigating the feasibility of hosting a freely available test instance on Amazon Web Services.</p>
-</div>
-<div class="section" id="requirements">
-<h2>requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
-<p>To run pylj locally it is necessary to have:</p>
-<ul class="simple">
-<li>python 3</li>
-<li>numpy</li>
-<li>matplotlib</li>
-<li>cython</li>
-<li>C++ complier</li>
-</ul>
-</div>
 </div>
 <div class="section" id="indices-and-tables">
 <h1>indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>

diff --git a/docs/build/html/modules.html b/docs/build/html/modules.html
@@ -1,5 +1,4 @@
 
-
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
@@ -10,6 +9,7 @@
     <title>pylj modules &#8212; pylj 0.0.6a documentation</title>
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <link rel="stylesheet" href="_static/my-styles.css" type="text/css" />
     <script type="text/javascript" src="_static/documentation_options.js"></script>
     <script type="text/javascript" src="_static/jquery.js"></script>
     <script type="text/javascript" src="_static/underscore.js"></script>
@@ -18,7 +18,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="pylj.comp" href="comp.html" />
-    <link rel="prev" title="pylj" href="index.html" />
+    <link rel="prev" title="pylj documentation" href="index.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
 
@@ -62,7 +62,7 @@ <h1 class="logo"><a href="index.html">pylj</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption"><span class="caption-text">Contents:</span></p>
+<p class="caption"><span class="caption-text">Package Contents:</span></p>
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">pylj modules</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="comp.html">pylj.comp</a></li>
@@ -72,14 +72,18 @@ <h3>Navigation</h3>
 <li class="toctree-l2"><a class="reference internal" href="util.html">pylj.util</a></li>
 </ul>
 </li>
+</ul>
+<p class="caption"><span class="caption-text">Help:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="using-pylj.html">using pylj</a></li>
 <li class="toctree-l1"><a class="reference internal" href="visualisation.html">visualisation</a></li>
 </ul>
 
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
   <li><a href="index.html">Documentation overview</a><ul>
-      <li>Previous: <a href="index.html" title="previous chapter">pylj</a></li>
+      <li>Previous: <a href="index.html" title="previous chapter">pylj documentation</a></li>
       <li>Next: <a href="comp.html" title="next chapter">pylj.comp</a></li>
   </ul></li>
 </ul>

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js