Skip to content

Commit

Permalink
Some documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
marcinmiklitz committed Jul 20, 2018
1 parent 886ef5d commit 58e28b6
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 1 deletion.
11 changes: 11 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,17 @@ For quick start head to :ref:`modindex` and see :class:`pywindow.molecular.Molec
:maxdepth: 2
:caption: Contents:

Installation
------------

Git clone the pywindow repository or download a zipped version.

.. code-block:: bash
cd pywindow/
python setup.py install
Examples
--------
Loading input
Expand Down
12 changes: 12 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">Welcome to <code class="docutils literal notranslate"><span class="pre">pywindow</span></code>’s documentation!</a><ul>
<li><a class="reference internal" href="#overview">Overview</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#examples">Examples</a><ul>
<li><a class="reference internal" href="#loading-input">Loading input</a></li>
<li><a class="reference internal" href="#pre-processing">Pre-processing</a></li>
Expand Down Expand Up @@ -166,6 +167,17 @@ <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this head
<div class="toctree-wrapper compound">
</div>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>Git clone the pywindow repository or download a zipped version.</p>
<blockquote>
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> pywindow/

python setup.py install
</pre></div>
</div>
</div></blockquote>
</div>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline"></a></h2>
<div class="section" id="loading-input">
Expand Down
Loading

0 comments on commit 58e28b6

Please sign in to comment.