Skip to content

Commit

Permalink
documentation, second commit
Browse files Browse the repository at this point in the history
  • Loading branch information
pjamesjoyce committed Feb 13, 2017
1 parent ce78fd7 commit 1910e34
Show file tree
Hide file tree
Showing 14 changed files with 370 additions and 111 deletions.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/installation.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/readme.doctree
Binary file not shown.
39 changes: 4 additions & 35 deletions docs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Welcome to lcopt's documentation!
.. toctree::
:maxdepth: 2
:caption: Contents:
:glob:

*




Expand All @@ -18,38 +22,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


lcopt
========

lcopt is a life cycle optimisation module for complex product systems

Features
--------

- Flexible model setup
- Integration with SimaPro and Brightway2

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

Install lcopt by running:

`pip install https://github.com/pjamesjoyce/lcopt/zipball/master`

Contribute
----------

- Issue Tracker: github.com/pjamesjoyce/lcopt/issues
- Source Code: github.com/pjamesjoyce/lcopt

Support
-------

If you are having issues, please let us know.

License
-------

The project is licensed under the BSD license.
7 changes: 7 additions & 0 deletions docs/_build/html/_sources/installation.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
============
Installation
============

Install the package with pip::

$ pip install https://github.com/pjamesjoyce/lcopt/zipball/master
34 changes: 34 additions & 0 deletions docs/_build/html/_sources/readme.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
========
Overview
========

lcopt is a life cycle optimisation module for complex product systems

Features
--------

- Flexible model setup
- Integration with SimaPro and Brightway2

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

Install lcopt by running:

`pip install https://github.com/pjamesjoyce/lcopt/zipball/master`

Contribute
----------

- Issue Tracker: github.com/pjamesjoyce/lcopt/issues
- Source Code: github.com/pjamesjoyce/lcopt

Support
-------

If you are having issues, please let us know.

License
-------

The project is licensed under the BSD license.
63 changes: 23 additions & 40 deletions docs/_build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
Expand All @@ -34,6 +35,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">lcopt documentation</a> &#187;</li>
</ul>
</div>
Expand All @@ -46,6 +50,18 @@ <h3>Navigation</h3>
<div class="section" id="welcome-to-lcopt-s-documentation">
<h1>Welcome to lcopt&#8217;s documentation!<a class="headerlink" href="#welcome-to-lcopt-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="readme.html">Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="readme.html#features">Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#contribute">Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#support">Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="readme.html#license">License</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
Expand All @@ -55,37 +71,6 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
<div class="section" id="lcopt">
<h1>lcopt<a class="headerlink" href="#lcopt" title="Permalink to this headline"></a></h1>
<p>lcopt is a life cycle optimisation module for complex product systems</p>
<div class="section" id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Flexible model setup</li>
<li>Integration with SimaPro and Brightway2</li>
</ul>
</div>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h2>
<p>Install lcopt by running:</p>
<p><cite>pip install https://github.com/pjamesjoyce/lcopt/zipball/master</cite></p>
</div>
<div class="section" id="contribute">
<h2>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li>Issue Tracker: github.com/pjamesjoyce/lcopt/issues</li>
<li>Source Code: github.com/pjamesjoyce/lcopt</li>
</ul>
</div>
<div class="section" id="support">
<h2>Support<a class="headerlink" href="#support" title="Permalink to this headline"></a></h2>
<p>If you are having issues, please let us know.</p>
</div>
<div class="section" id="license">
<h2>License<a class="headerlink" href="#license" title="Permalink to this headline"></a></h2>
<p>The project is licensed under the BSD license.</p>
</div>
</div>


Expand All @@ -98,16 +83,11 @@ <h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to lcopt&#8217;s documentation!</a></li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
<li><a class="reference internal" href="#lcopt">lcopt</a><ul>
<li><a class="reference internal" href="#features">Features</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#contribute">Contribute</a></li>
<li><a class="reference internal" href="#support">Support</a></li>
<li><a class="reference internal" href="#license">License</a></li>
</ul>
</li>
</ul>

<h4>Next topic</h4>
<p class="topless"><a href="installation.html"
title="next chapter">Installation</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -135,6 +115,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="installation.html" title="Installation"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">lcopt documentation</a> &#187;</li>
</ul>
</div>
Expand Down
115 changes: 115 additions & 0 deletions docs/_build/html/installation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Installation &#8212; lcopt documentation</title>

<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="lcopt" href="readme.html" />
<link rel="prev" title="Welcome to lcopt’s documentation!" href="index.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="readme.html" title="lcopt"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to lcopt’s documentation!"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">lcopt documentation</a> &#187;</li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline"></a></h1>
<p>Install the package with pip:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install https://github.com/pjamesjoyce/lcopt/zipball/master
</pre></div>
</div>
</div>


</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Welcome to lcopt&#8217;s documentation!</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="readme.html"
title="next chapter">lcopt</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/installation.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="readme.html" title="lcopt"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to lcopt’s documentation!"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">lcopt documentation</a> &#187;</li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2017, P. James Joyce.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.
</div>
</body>
</html>
Binary file modified docs/_build/html/objects.inv
Binary file not shown.

0 comments on commit 1910e34

Please sign in to comment.