Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Freakwill
Freakwill committed Nov 27, 2024
1 parent 724f5c4 commit 8185d25
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 76 deletions.
Binary file modified docs/build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Binary file not shown.
9 changes: 1 addition & 8 deletions docs/build/html/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,7 @@ Welcome to pyrimidine's world of genetic algorithm
:maxdepth: 2
:caption: Document

source/Home
source/Install
source/Release History
source/API Design
source/Examples
source/Customization
source/Helpers
source/Media
source/index

.. toctree::
:maxdepth: 1
Expand Down
78 changes: 19 additions & 59 deletions docs/build/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="pyrimidine: a universal framework for genetic algorithm" href="source/Home.html" />
<link rel="next" title="Welcome to pyrimidine’s world of genetic algorithm" href="source/index.html" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
<!--[if lte IE 6]>
Expand All @@ -34,7 +34,7 @@ <h3>Navigation</h3>
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="source/Home.html" title="pyrimidine: a universal framework for genetic algorithm"
<a href="source/index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">pyrimidine 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to pyrimidine’s world of genetic algorithm</a></li>
Expand All @@ -54,64 +54,24 @@ <h1>Welcome to pyrimidine’s world of genetic algorithm<a class="headerlink" hr
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Document</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="source/Home.html">pyrimidine: a universal framework for genetic algorithm</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Home.html#why">Why</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Home.html#download">Download</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Home.html#idea-of-algebra-inspired">Idea of algebra-inspired</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Home.html#fitness">Fitness</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Home.html#statement-of-need">Statement of need</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/index.html">Welcome to pyrimidine’s world of genetic algorithm</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Home.html">pyrimidine: a universal framework for genetic algorithm</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Install.html">Installation and Getting Started</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Release%20History.html">Release History</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html">API Design</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Examples.html">Examples and Comparison of Algorithms</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Customization.html">Customization</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Helpers.html">Helpers</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Developers.html">Developers</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Media.html">Misc</a></li>
<li class="toctree-l2"><a class="reference external" href="https://github.com/Freakwill/pyrimidine">GitHub Page</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/Install.html">Installation and Getting Started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Install.html#install-pyrimidine">Install pyrimidine</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Install.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Install.html#first-test">First test</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/index.html#modules-overview">Modules Overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/pyrimidine.html">pyrimidine package</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/Release%20History.html">Release History</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Release%20History.html#v1-7">v1.7</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Release%20History.html#v1-6">v1.6</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Release%20History.html#v1-5">v1.5</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Release%20History.html#before-v1-5">before v1.5</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/API%20Design.html">API Design</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html#modules">Modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html#metaclasses">Metaclasses</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html#mixin-classes">Mixin Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html#basic-classes">Basic Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html#methods">Methods</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html#arguments-parameters-attributions">Arguments/Parameters/Attributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/API%20Design.html#params-alias"><code class="docutils literal notranslate"><span class="pre">params</span></code>/<code class="docutils literal notranslate"><span class="pre">alias</span></code></a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/Examples.html">Examples and Comparison of Algorithms</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Examples.html#example-1">Example 1</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Examples.html#example-2">Example 2</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Examples.html#example-3-evolution-strategy">Example 3 — Evolution Strategy</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Examples.html#example-4-quantum-ga">Example 4 — Quantum GA</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Examples.html#example-5-multipopulation">Example 5 — MultiPopulation</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Examples.html#exmaple-6-game">Exmaple 6 — Game</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/Customization.html">Customization</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Customization.html#principle">Principle</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Customization.html#customization-tricks">Customization Tricks</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Customization.html#evolution-strategy">Evolution Strategy</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Customization.html#differential-evolution">Differential Evolution</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Customization.html#local-search">Local Search</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Customization.html#hacking">Hacking</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/Helpers.html">Helpers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Helpers.html#optimization">Optimization</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Helpers.html#decorators">Decorators</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/Media.html">Misc</a><ul>
<li class="toctree-l2"><a class="reference internal" href="source/Media.html#pictures">Pictures</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Media.html#videos">Videos</a></li>
<li class="toctree-l2"><a class="reference internal" href="source/Media.html#tutorial">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="source/index.html#indices">Indices</a><ul class="simple">
</ul>
</li>
</ul>
Expand Down Expand Up @@ -165,8 +125,8 @@ <h3><a href="#">Table of Contents</a></h3>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="source/Home.html"
title="next chapter">pyrimidine: a universal framework for genetic algorithm</a></p>
<p class="topless"><a href="source/index.html"
title="next chapter">Welcome to pyrimidine’s world of genetic algorithm</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
Expand Down Expand Up @@ -199,7 +159,7 @@ <h3>Navigation</h3>
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="source/Home.html" title="pyrimidine: a universal framework for genetic algorithm"
<a href="source/index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">pyrimidine 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to pyrimidine’s world of genetic algorithm</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions docs/build/html/source/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
<script defer="defer" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="pyrimidine: a universal framework for genetic algorithm" href="Home.html" />
<link rel="prev" title="Welcome to pyrimidine’s world of genetic algorithm" href="../index.html" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Neuton&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Nobile:regular,italic,bold,bolditalic&amp;subset=latin" type="text/css" media="screen" charset="utf-8" />
<!--[if lte IE 6]>
Expand All @@ -32,6 +34,12 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Home.html" title="pyrimidine: a universal framework for genetic algorithm"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pyrimidine 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to pyrimidine’s world of genetic algorithm</a></li>
</ul>
Expand Down Expand Up @@ -156,6 +164,16 @@ <h3><a href="../index.html">Table of Contents</a></h3>
</ul>

</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../index.html"
title="previous chapter">Welcome to pyrimidine’s world of genetic algorithm</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="Home.html"
title="next chapter">pyrimidine: a universal framework for genetic algorithm</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -186,6 +204,12 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Home.html" title="pyrimidine: a universal framework for genetic algorithm"
>next</a> |</li>
<li class="right" >
<a href="../index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">pyrimidine 1.7 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Welcome to pyrimidine’s world of genetic algorithm</a></li>
</ul>
Expand Down
9 changes: 1 addition & 8 deletions docs/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,7 @@ Welcome to pyrimidine's world of genetic algorithm
:maxdepth: 2
:caption: Document

source/Home
source/Install
source/Release History
source/API Design
source/Examples
source/Customization
source/Helpers
source/Media
source/index

.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit 8185d25

Please sign in to comment.