(#60) fix(docs): Exclude special members (e.g., __dict__) from Sphinx…

…-generated documentation
SevgiAkten · Aug 13, 2024 · 00ba8ea · 00ba8ea
1 parent 91524fd
commit 00ba8ea
Show file tree

Hide file tree

Showing 30 changed files with 17 additions and 2,872 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/src.doctree b/docs/_build/doctrees/src.doctree
diff --git a/docs/_build/doctrees/src.example.doctree b/docs/_build/doctrees/src.example.doctree
diff --git a/docs/_build/doctrees/src.mutation.doctree b/docs/_build/doctrees/src.mutation.doctree
diff --git a/docs/_build/doctrees/src.neighborhoods.doctree b/docs/_build/doctrees/src.neighborhoods.doctree
diff --git a/docs/_build/doctrees/src.problems.doctree b/docs/_build/doctrees/src.problems.doctree
diff --git a/docs/_build/doctrees/src.problems.single_objective.continuous.doctree b/docs/_build/doctrees/src.problems.single_objective.continuous.doctree
diff --git a/docs/_build/doctrees/src.problems.single_objective.discrete.binary.doctree b/docs/_build/doctrees/src.problems.single_objective.discrete.binary.doctree
diff --git a/docs/_build/doctrees/src.problems.single_objective.discrete.permutation.doctree b/docs/_build/doctrees/src.problems.single_objective.discrete.permutation.doctree
diff --git a/docs/_build/doctrees/src.recombination.doctree b/docs/_build/doctrees/src.recombination.doctree
diff --git a/docs/_build/doctrees/src.selection.doctree b/docs/_build/doctrees/src.selection.doctree
diff --git a/docs/_build/doctrees/src.tests.doctree b/docs/_build/doctrees/src.tests.doctree
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
diff --git a/docs/_build/html/modules.html b/docs/_build/html/modules.html
@@ -238,10 +238,7 @@ <h1>pycellga<a class="headerlink" href="#pycellga" title="Link to this heading">
 <li class="toctree-l3"><a class="reference internal" href="src.html#src.grid.Grid"><code class="docutils literal notranslate"><span class="pre">Grid</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="src.html#src.grid.Grid.n_rows"><code class="docutils literal notranslate"><span class="pre">Grid.n_rows</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="src.html#src.grid.Grid.n_cols"><code class="docutils literal notranslate"><span class="pre">Grid.n_cols</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.html#src.grid.Grid.__dict__"><code class="docutils literal notranslate"><span class="pre">Grid.__dict__</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="src.html#src.grid.Grid.__init__"><code class="docutils literal notranslate"><span class="pre">Grid.__init__()</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.html#src.grid.Grid.__module__"><code class="docutils literal notranslate"><span class="pre">Grid.__module__</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="src.html#src.grid.Grid.__weakref__"><code class="docutils literal notranslate"><span class="pre">Grid.__weakref__</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="src.html#src.grid.Grid.make_2d_grid"><code class="docutils literal notranslate"><span class="pre">Grid.make_2d_grid()</span></code></a></li>
 </ul>
 </li>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/src.example.html b/docs/_build/html/src.example.html
diff --git a/docs/_build/html/src.html b/docs/_build/html/src.html
diff --git a/docs/_build/html/src.mutation.html b/docs/_build/html/src.mutation.html
diff --git a/docs/_build/html/src.neighborhoods.html b/docs/_build/html/src.neighborhoods.html
diff --git a/docs/_build/html/src.problems.html b/docs/_build/html/src.problems.html
@@ -163,22 +163,6 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
 <dd><p>Evaluates the fitness of a given solution x.</p>
 </dd></dl>
 
-<dl class="py attribute">
-<dt class="sig sig-object py" id="src.problems.abstract_problem.AbstractProblem.__dict__">
-<span class="sig-name descname"><span class="pre">__dict__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">mappingproxy({'__module__':</span> <span class="pre">'src.problems.abstract_problem',</span> <span class="pre">'__doc__':</span> <span class="pre">'\n</span>&#160;&#160;&#160; <span class="pre">An</span> <span class="pre">abstract</span> <span class="pre">base</span> <span class="pre">class</span> <span class="pre">for</span> <span class="pre">optimization</span> <span class="pre">problems.\n\n</span>&#160;&#160;&#160; <span class="pre">Methods\n</span>&#160;&#160;&#160; <span class="pre">-------\n</span>&#160;&#160;&#160; <span class="pre">f(x)\n</span>&#160;&#160;&#160;&#160;&#160;&#160;&#160; <span class="pre">Evaluates</span> <span class="pre">the</span> <span class="pre">fitness</span> <span class="pre">of</span> <span class="pre">a</span> <span class="pre">given</span> <span class="pre">solution</span> <span class="pre">x.\n</span>&#160;&#160;&#160; <span class="pre">',</span> <span class="pre">'f':</span> <span class="pre">&lt;function</span> <span class="pre">AbstractProblem.f&gt;,</span> <span class="pre">'__dict__':</span> <span class="pre">&lt;attribute</span> <span class="pre">'__dict__'</span> <span class="pre">of</span> <span class="pre">'AbstractProblem'</span> <span class="pre">objects&gt;,</span> <span class="pre">'__weakref__':</span> <span class="pre">&lt;attribute</span> <span class="pre">'__weakref__'</span> <span class="pre">of</span> <span class="pre">'AbstractProblem'</span> <span class="pre">objects&gt;,</span> <span class="pre">'__annotations__':</span> <span class="pre">{}})</span></em><a class="headerlink" href="#src.problems.abstract_problem.AbstractProblem.__dict__" title="Link to this definition"></a></dt>
-<dd></dd></dl>
-
-<dl class="py attribute">
-<dt class="sig sig-object py" id="src.problems.abstract_problem.AbstractProblem.__module__">
-<span class="sig-name descname"><span class="pre">__module__</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'src.problems.abstract_problem'</span></em><a class="headerlink" href="#src.problems.abstract_problem.AbstractProblem.__module__" title="Link to this definition"></a></dt>
-<dd></dd></dl>
-
-<dl class="py attribute">
-<dt class="sig sig-object py" id="src.problems.abstract_problem.AbstractProblem.__weakref__">
-<span class="sig-name descname"><span class="pre">__weakref__</span></span><a class="headerlink" href="#src.problems.abstract_problem.AbstractProblem.__weakref__" title="Link to this definition"></a></dt>
-<dd><p>list of weak references to the object (if defined)</p>
-</dd></dl>
-
 <dl class="py method">
 <dt class="sig sig-object py" id="id0">
 <span class="sig-name descname"><span class="pre">f</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/src/problems/abstract_problem.html#AbstractProblem.f"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id0" title="Link to this definition"></a></dt>

diff --git a/docs/_build/html/src.problems.single_objective.continuous.html b/docs/_build/html/src.problems.single_objective.continuous.html