Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Freakwill committed Nov 28, 2024
1 parent 39ed733 commit f148ef6
Show file tree
Hide file tree
Showing 28 changed files with 155 additions and 74 deletions.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/source/API Design.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/source/Home.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/source/index.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/source/pyrimidine.doctree
Binary file not shown.
Binary file added docs/build/html/_images/green_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/build/html/_images/transparent_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 4 additions & 7 deletions docs/build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
Welcome to pyrimidine's world of genetic algorithm
====================================================================

.. image:: source/logo.png
.. image:: source/transparent_logo.png
:width: 200
:height: 200

Expand Down Expand Up @@ -42,9 +42,6 @@ Modules Overview
Indices
==================

.. toctree::
:maxdepth: 2

genindex
modindex
search
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2 changes: 1 addition & 1 deletion docs/build/html/_sources/source/API Design.md.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Design

.. api-design:
API design principles

## Modules

Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_sources/source/Home.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

It is a highly object-oriental implement of genetic algorithm by Python.

![LOGO](logo.png)
![LOGO](green_logo.png)


## Why
Expand Down
22 changes: 11 additions & 11 deletions docs/build/html/_sources/source/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
.. pyrimidine documentation master file, created by
sphinx-quickstart on Dec 18 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Document of `pyrimidine`
===========================

Welcome to pyrimidine's world of genetic algorithm
====================================================================

.. image:: source/logo.png
.. image:: source/green_logo.png
:width: 200
:height: 200

**pyrimidine** is a competitive framework for genetic algorithms or any type of evolutionary algorithms.

.. toctree::
:maxdepth: 2
:caption: Contents
Expand All @@ -23,5 +16,12 @@ Welcome to pyrimidine's world of genetic algorithm
Examples
Customization
Helpers
Developers
Media


Indices
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
2 changes: 1 addition & 1 deletion docs/build/html/_sources/source/pyrimidine.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ pyrimidine.studga module
:show-inheritance:

pyrimidine.utils module
-----------------------0
------------------------

.. automodule:: pyrimidine.utils
:members:
Expand Down
24 changes: 11 additions & 13 deletions docs/build/html/index.html
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="Welcome to pyrimidine’s world of genetic algorithm" href="source/index.html" />
<link rel="next" title="Document of pyrimidine" 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/index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
<a href="source/index.html" title="Document of pyrimidine"
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 @@ -48,24 +48,24 @@ <h3>Navigation</h3>

<section id="welcome-to-pyrimidine-s-world-of-genetic-algorithm">
<h1>Welcome to pyrimidine’s world of genetic algorithm<a class="headerlink" href="#welcome-to-pyrimidine-s-world-of-genetic-algorithm" title="Link to this heading"></a></h1>
<a class="reference internal image-reference" href="_images/logo.png"><img alt="_images/logo.png" src="_images/logo.png" style="width: 200px; height: 200px;" />
<a class="reference internal image-reference" href="_images/transparent_logo.png"><img alt="_images/transparent_logo.png" src="_images/transparent_logo.png" style="width: 200px; height: 200px;" />
</a>
<p><strong>pyrimidine</strong> is a competitive framework for genetic algorithms or any type of evolutionary algorithms.</p>
<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/index.html">Welcome to pyrimidine’s world of genetic algorithm</a><ul>
<li class="toctree-l1"><a class="reference internal" href="source/index.html">Document of <cite>pyrimidine</cite></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>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="source/index.html#indices">Indices</a></li>
</ul>
</div>
<div class="toctree-wrapper compound">
Expand All @@ -91,13 +91,11 @@ <h1>Modules Overview<a class="headerlink" href="#modules-overview" title="Link t
</section>
<section id="indices">
<h1>Indices<a class="headerlink" href="#indices" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Module Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="search.html">Search Page</a></li>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</section>


Expand All @@ -121,7 +119,7 @@ <h3><a href="#">Table of Contents</a></h3>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="source/index.html"
title="next chapter">Welcome to pyrimidine’s world of genetic algorithm</a></p>
title="next chapter">Document of <cite>pyrimidine</cite></a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
Expand Down Expand Up @@ -154,7 +152,7 @@ <h3>Navigation</h3>
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="source/index.html" title="Welcome to pyrimidine’s world of genetic algorithm"
<a href="source/index.html" title="Document of pyrimidine"
>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
Binary file modified docs/build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

28 changes: 27 additions & 1 deletion docs/build/html/source/API Design.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Examples and Comparison of Algorithms" href="Examples.html" />
<link rel="prev" title="Release History" href="Release%20History.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 @@ -30,7 +32,14 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Examples.html" title="Examples and Comparison of Algorithms"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Release%20History.html" title="Release History"
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-1"><a href="index.html" accesskey="U">Document of <cite>pyrimidine</cite></a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Design</a></li>
</ul>
</div>
Expand All @@ -42,7 +51,7 @@ <h3>Navigation</h3>

<section class="tex2jax_ignore mathjax_ignore" id="api-design">
<h1>API Design<a class="headerlink" href="#api-design" title="Link to this heading"></a></h1>
<p>… api-design:</p>
<p>API design principles</p>
<section id="modules">
<h2>Modules<a class="headerlink" href="#modules" title="Link to this heading"></a></h2>
<p>Short introduction to modules:</p>
Expand Down Expand Up @@ -257,6 +266,16 @@ <h3><a href="../index.html">Table of Contents</a></h3>
</ul>

</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="Release%20History.html"
title="previous chapter">Release History</a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="Examples.html"
title="next chapter">Examples and Comparison of Algorithms</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -287,7 +306,14 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Examples.html" title="Examples and Comparison of Algorithms"
>next</a> |</li>
<li class="right" >
<a href="Release%20History.html" title="Release History"
>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-1"><a href="index.html" >Document of <cite>pyrimidine</cite></a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">API Design</a></li>
</ul>
</div>
Expand Down
28 changes: 27 additions & 1 deletion docs/build/html/source/Home.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Installation and Getting Started" href="Install.html" />
<link rel="prev" title="Document of pyrimidine" 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 @@ -30,7 +32,14 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Install.html" title="Installation and Getting Started"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Document of pyrimidine"
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-1"><a href="index.html" accesskey="U">Document of <cite>pyrimidine</cite></a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyrimidine: a universal framework for genetic algorithm</a></li>
</ul>
</div>
Expand All @@ -43,7 +52,7 @@ <h3>Navigation</h3>
<section class="tex2jax_ignore mathjax_ignore" id="pyrimidine-a-universal-framework-for-genetic-algorithm">
<h1>pyrimidine: a universal framework for genetic algorithm<a class="headerlink" href="#pyrimidine-a-universal-framework-for-genetic-algorithm" title="Link to this heading"></a></h1>
<p>It is a highly object-oriental implement of genetic algorithm by Python.</p>
<p><img alt="LOGO" src="../_images/logo.png" /></p>
<p><img alt="LOGO" src="../_images/green_logo.png" /></p>
<section id="why">
<h2>Why<a class="headerlink" href="#why" title="Link to this heading"></a></h2>
<p>Why is the package named as “pyrimidine”? Because it begins with “py”.</p>
Expand Down Expand Up @@ -197,6 +206,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">Document of <cite>pyrimidine</cite></a></p>
</div>
<div>
<h4>Next topic</h4>
<p class="topless"><a href="Install.html"
title="next chapter">Installation and Getting Started</a></p>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
Expand Down Expand Up @@ -227,7 +246,14 @@ <h3>Navigation</h3>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Install.html" title="Installation and Getting Started"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="Document of pyrimidine"
>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-1"><a href="index.html" >Document of <cite>pyrimidine</cite></a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">pyrimidine: a universal framework for genetic algorithm</a></li>
</ul>
</div>
Expand Down
34 changes: 22 additions & 12 deletions docs/build/html/source/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<title>Welcome to pyrimidine’s world of genetic algorithm &#8212; pyrimidine 1.7 documentation</title>
<title>Document of pyrimidine &#8212; pyrimidine 1.7 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4848ba22" />
<link rel="stylesheet" type="text/css" href="../_static/pyramid.css?v=310c80ee" />
<script src="../_static/documentation_options.js?v=392da36c"></script>
Expand Down Expand Up @@ -41,7 +41,7 @@ <h3>Navigation</h3>
<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>
<li class="nav-item nav-item-this"><a href="">Document of <cite>pyrimidine</cite></a></li>
</ul>
</div>

Expand All @@ -50,11 +50,10 @@ <h3>Navigation</h3>
<div class="bodywrapper">
<div class="body" role="main">

<section id="welcome-to-pyrimidine-s-world-of-genetic-algorithm">
<h1>Welcome to pyrimidine’s world of genetic algorithm<a class="headerlink" href="#welcome-to-pyrimidine-s-world-of-genetic-algorithm" title="Link to this heading"></a></h1>
<a class="reference internal image-reference" href="source/source/logo.png"><img alt="source/source/logo.png" src="source/source/logo.png" style="width: 200px; height: 200px;" />
<section id="document-of-pyrimidine">
<h1>Document of <cite>pyrimidine</cite><a class="headerlink" href="#document-of-pyrimidine" title="Link to this heading"></a></h1>
<a class="reference internal image-reference" href="source/source/green_logo.png"><img alt="source/source/green_logo.png" src="source/source/green_logo.png" style="width: 200px; height: 200px;" />
</a>
<p><strong>pyrimidine</strong> is a competitive framework for genetic algorithms or any type of evolutionary algorithms.</p>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul>
Expand Down Expand Up @@ -112,11 +111,6 @@ <h1>Welcome to pyrimidine’s world of genetic algorithm<a class="headerlink" hr
<li class="toctree-l2"><a class="reference internal" href="Helpers.html#decorators">Decorators</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Developers.html">Developers</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Developers.html#id1">Developers</a></li>
<li class="toctree-l2"><a class="reference internal" href="Developers.html#philosophy">Philosophy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Media.html">Misc</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Media.html#pictures">Pictures</a></li>
<li class="toctree-l2"><a class="reference internal" href="Media.html#videos">Videos</a></li>
Expand All @@ -125,6 +119,14 @@ <h1>Welcome to pyrimidine’s world of genetic algorithm<a class="headerlink" hr
</li>
</ul>
</div>
</section>
<section id="indices">
<h1>Indices<a class="headerlink" href="#indices" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="../genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="../py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="../search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>


Expand All @@ -134,6 +136,14 @@ <h1>Welcome to pyrimidine’s world of genetic algorithm<a class="headerlink" hr
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Document of <cite>pyrimidine</cite></a></li>
<li><a class="reference internal" href="#indices">Indices</a></li>
</ul>

</div>
<div>
<h4>Previous topic</h4>
<p class="topless"><a href="../index.html"
Expand Down Expand Up @@ -181,7 +191,7 @@ <h3>Navigation</h3>
<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>
<li class="nav-item nav-item-this"><a href="">Document of <cite>pyrimidine</cite></a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
Expand Down
Loading

0 comments on commit f148ef6

Please sign in to comment.