Skip to content

Commit

Permalink
Destroys and regenerates Sphinx documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
@HugoFara
HugoFara committed Jun 30, 2024
1 parent 7bf185d commit 5df3ce8
Show file tree
Hide file tree
Showing 21 changed files with 924 additions and 486 deletions.
5 changes: 3 additions & 2 deletions .idea/runConfigurations/Sphinx_Documentation.xml
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions docs/_sources/api/interface.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ Joint definition
:private-members:
:special-members: __init__


Revolute joint definition
=========================
.. automodule:: pylinkage.interface.revolute_joint
:members:
:undoc-members:
:show-inheritance:
:private-members:
:special-members: __init__

Linkage definition
==================
.. automodule:: pylinkage.interface.linkage
Expand Down
3 changes: 2 additions & 1 deletion docs/_sources/changeloglink.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.. mdinclude:: ../CHANGELOG.md
.. include:: ../CHANGELOG.md
:parser: myst_parser.sphinx_
2 changes: 2 additions & 0 deletions docs/_sources/code_of_conductlink.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../CODE_OF_CONDUCT.md
:parser: myst_parser.sphinx_
1 change: 1 addition & 0 deletions docs/_sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Welcome to pylinkage's documentation!
Source Code <https://github.com/HugoFara/pylinkage>
Download on PyPi <https://pypi.org/project/pylinkage/>
Get Support <https://github.com/HugoFara/pylinkage/issues>
Code of Conduct <code_of_conductlink.rst>

.. include:: readmelink.rst

Expand Down
3 changes: 2 additions & 1 deletion docs/_sources/readmelink.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
.. mdinclude:: ../README.md
.. include:: ../README.md
:parser: myst_parser.sphinx_
41 changes: 23 additions & 18 deletions docs/api/collections.html
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>collections &mdash; pylinkage 0.5.3 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=92fd9be5" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=08553120"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Contributor Covenant Code of Conduct" href="../code_of_conductlink.html" />
<link rel="prev" title="visualizer" href="visualizer.html" />
</head>

Expand Down Expand Up @@ -76,6 +79,7 @@
<li class="toctree-l1"><a class="reference external" href="https://github.com/HugoFara/pylinkage">Source Code</a></li>
<li class="toctree-l1"><a class="reference external" href="https://pypi.org/project/pylinkage/">Download on PyPi</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/HugoFara/pylinkage/issues">Get Support</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_of_conductlink.html">Code of Conduct</a></li>
</ul>

</div>
Expand Down Expand Up @@ -103,44 +107,44 @@
<div itemprop="articleBody">

<section id="collections">
<h1>collections<a class="headerlink" href="#collections" title="Permalink to this heading"></a></h1>
<h1>collections<a class="headerlink" href="#collections" title="Link to this heading"></a></h1>
<section id="module-pylinkage.collections.agent">
<span id="agent"></span><h2>Agent<a class="headerlink" href="#module-pylinkage.collections.agent" title="Permalink to this heading"></a></h2>
<span id="agent"></span><h2>Agent<a class="headerlink" href="#module-pylinkage.collections.agent" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pylinkage.collections.agent.Agent">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylinkage.collections.agent.</span></span><span class="sig-name descname"><span class="pre">Agent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dimensions</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">init_positions</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylinkage.collections.agent.Agent" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylinkage.collections.agent.</span></span><span class="sig-name descname"><span class="pre">Agent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dimensions</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">init_positions</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylinkage.collections.agent.Agent" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="#pylinkage.collections.agent.Agent" title="pylinkage.collections.agent.Agent"><code class="xref py py-class docutils literal notranslate"><span class="pre">Agent</span></code></a></p>
<p>A class that uniformizes a linkage optimization.</p>
<p>It is roughly a namedtuple with preassigned fields.</p>
</dd></dl>

</section>
<section id="module-pylinkage.collections.mutable_agent">
<span id="mutableagent"></span><h2>MutableAgent<a class="headerlink" href="#module-pylinkage.collections.mutable_agent" title="Permalink to this heading"></a></h2>
<span id="mutableagent"></span><h2>MutableAgent<a class="headerlink" href="#module-pylinkage.collections.mutable_agent" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="pylinkage.collections.mutable_agent.MutableAgent">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylinkage.collections.mutable_agent.</span></span><span class="sig-name descname"><span class="pre">MutableAgent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dimensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">init_position</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pylinkage.collections.mutable_agent.</span></span><span class="sig-name descname"><span class="pre">MutableAgent</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dimensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">init_position</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A custom class that is mutable, subscriptable, and supports index assignment.</p>
<p>You should only use it as a dictionary of 3 elements. No backward compatibility guaranty on other use cases.</p>
<dl class="py method">
<dt class="sig sig-object py" id="pylinkage.collections.mutable_agent.MutableAgent.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dimensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">init_position</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.__init__" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">score</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dimensions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">init_position</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pylinkage.collections.mutable_agent.MutableAgent.dimensions">
<span class="sig-name descname"><span class="pre">dimensions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span></em><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.dimensions" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">dimensions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span></em><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.dimensions" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pylinkage.collections.mutable_agent.MutableAgent.init_positions">
<span class="sig-name descname"><span class="pre">init_positions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span></em><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.init_positions" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">init_positions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span></em><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.init_positions" title="Link to this definition"></a></dt>
<dd></dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="pylinkage.collections.mutable_agent.MutableAgent.score">
<span class="sig-name descname"><span class="pre">score</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.score" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">score</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#pylinkage.collections.mutable_agent.MutableAgent.score" title="Link to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>
Expand All @@ -153,6 +157,7 @@ <h1>collections<a class="headerlink" href="#collections" title="Permalink to thi
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="visualizer.html" class="btn btn-neutral float-left" title="visualizer" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../code_of_conductlink.html" class="btn btn-neutral float-right" title="Contributor Covenant Code of Conduct" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Loading

0 comments on commit 5df3ce8

Please sign in to comment.