added docs

100 · Jun 20, 2017 · 4302e24 · 4302e24
1 parent 98a152f
commit 4302e24
Show file tree

Hide file tree

Showing 46 changed files with 18,083 additions and 13 deletions.
diff --git a/.gitignore b/.gitignore
@@ -100,4 +100,6 @@ ENV/
 # mypy
 .mypy_cache/
 
-.idea/
+.idea/
+
+sphinx/
diff --git a/README.md b/README.md
@@ -1,12 +1,13 @@
-<div align="center>
-# Solid
+<div align="center">
+    <img src="logo.png"></img>
 </div>
+
 <br>
 
 [![Build Status](https://travis-ci.org/100/Solid.svg?branch=master)](https://travis-ci.org/100/Solid)
 [![MIT License](https://img.shields.io/dub/l/vibe-d.svg)](https://github.com/100/Cranium/blob/master/LICENSE)
 
-## *Solid* is a simple Python library for gradient-free optimization.
+## *Solid* is a Python library for gradient-free optimization.
 
 #### It contains basic versions of many of the most common algorithms, and allows for very rapid development using them.
 
@@ -15,13 +16,13 @@
 <hr>
 
 ## Current Features:
-* Genetic Algorithm
-* Evolutionary Algorithm
-* Simulated Annealing
-* Particle Swarm Optimization
-* Tabu Search
-* Harmony Search
-* Stochastic Hill Climb
+* [Genetic Algorithm](https://github.com/100/Solid/blob/master/Solid/GeneticAlgorithm.py)
+* [Evolutionary Algorithm](https://github.com/100/Solid/blob/master/Solid/EvolutionaryAlgorithm.py)
+* [Simulated Annealing](https://github.com/100/Solid/blob/master/Solid/SimulatedAnnealing.py)
+* [Particle Swarm Optimization](https://github.com/100/Solid/blob/master/Solid/ParticleSwarm.py)
+* [Tabu Search](https://github.com/100/Solid/blob/master/Solid/TabuSearch.py)
+* [Harmony Search](https://github.com/100/Solid/blob/master/Solid/HarmonySearch.py)
+* [Stochastic Hill Climb](https://github.com/100/Solid/blob/master/Solid/StochasticHillClimb.py)
 
 <hr>
 
@@ -65,13 +66,13 @@ class Algorithm(EvolutionaryAlgorithm):
 
 def test_algorithm():
     algorithm = Algorithm(.5, .7, 500, max_fitness=None)
-    algorithm.run()
+    best_solution, best_objective_value = algorithm.run()
 
 ```
 
 <hr>
 
-## Building and Testing
+## Testing
 
 To run tests, look in the ```tests``` folder. 
 

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: b691e48017afb30514be38e8c3446b04
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/Solid.html b/docs/Solid.html
diff --git a/docs/_modules/Solid/EvolutionaryAlgorithm.html b/docs/_modules/Solid/EvolutionaryAlgorithm.html
diff --git a/docs/_modules/Solid/GeneticAlgorithm.html b/docs/_modules/Solid/GeneticAlgorithm.html
diff --git a/docs/_modules/Solid/HarmonySearch.html b/docs/_modules/Solid/HarmonySearch.html
diff --git a/docs/_modules/Solid/ParticleSwarm.html b/docs/_modules/Solid/ParticleSwarm.html
diff --git a/docs/_modules/Solid/SimulatedAnnealing.html b/docs/_modules/Solid/SimulatedAnnealing.html
diff --git a/docs/_modules/Solid/StochasticHillClimb.html b/docs/_modules/Solid/StochasticHillClimb.html
diff --git a/docs/_modules/Solid/TabuSearch.html b/docs/_modules/Solid/TabuSearch.html
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -0,0 +1,92 @@
+
+<!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>Overview: module code &#8212; Solid 0.11 documentation</title>
+
+    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     '0.11',
+        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="stylesheet" href="../_static/custom.css" type="text/css" />
+
+
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head>
+  <body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="Solid/EvolutionaryAlgorithm.html">Solid.EvolutionaryAlgorithm</a></li>
+<li><a href="Solid/GeneticAlgorithm.html">Solid.GeneticAlgorithm</a></li>
+<li><a href="Solid/HarmonySearch.html">Solid.HarmonySearch</a></li>
+<li><a href="Solid/ParticleSwarm.html">Solid.ParticleSwarm</a></li>
+<li><a href="Solid/SimulatedAnnealing.html">Solid.SimulatedAnnealing</a></li>
+<li><a href="Solid/StochasticHillClimb.html">Solid.StochasticHillClimb</a></li>
+<li><a href="Solid/TabuSearch.html">Solid.TabuSearch</a></li>
+</ul>
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper"><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+  </ul></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="footer">
+      &copy;2017, Devin Soni.
+
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.2</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>
diff --git a/docs/_sources/Solid.rst.txt b/docs/_sources/Solid.rst.txt
@@ -0,0 +1,70 @@
+Solid package
+=============
+
+Submodules
+----------
+
+Solid\.EvolutionaryAlgorithm module
+-----------------------------------
+
+.. automodule:: Solid.EvolutionaryAlgorithm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Solid\.GeneticAlgorithm module
+------------------------------
+
+.. automodule:: Solid.GeneticAlgorithm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Solid\.HarmonySearch module
+---------------------------
+
+.. automodule:: Solid.HarmonySearch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Solid\.ParticleSwarm module
+---------------------------
+
+.. automodule:: Solid.ParticleSwarm
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Solid\.SimulatedAnnealing module
+--------------------------------
+
+.. automodule:: Solid.SimulatedAnnealing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Solid\.StochasticHillClimb module
+---------------------------------
+
+.. automodule:: Solid.StochasticHillClimb
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Solid\.TabuSearch module
+------------------------
+
+.. automodule:: Solid.TabuSearch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: Solid
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,20 @@
+.. Solid documentation master file, created by
+   sphinx-quickstart on Mon Jun 19 19:02:57 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Solid's documentation!
+=================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/_sources/modules.rst.txt b/docs/_sources/modules.rst.txt
@@ -0,0 +1,7 @@
+Solid
+=====
+
+.. toctree::
+   :maxdepth: 4
+
+   Solid
diff --git a/docs/_static/ajax-loader.gif b/docs/_static/ajax-loader.gif
-Original file line number
+Diff line change
@@ Expand Up / @@ -100,4 +100,6 @@ ENV/ @@
     # mypy
     .mypy_cache/
-    .idea/
+    .idea/
+    sphinx/