German Larrain avatar German Larrain committed c75c1da

doc: added rst files generated by apidoc

Comments (0)

Files changed (16)

docs/sphinx/source/apidoc/ars.app.rst

+app Package
+===========
+
+:mod:`app` Package
+------------------
+
+.. automodule:: ars.app
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.graphics.rst

+graphics Package
+================
+
+:mod:`graphics` Package
+-----------------------
+
+.. automodule:: ars.graphics
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`adapters` Module
+----------------------
+
+.. automodule:: ars.graphics.adapters
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.gui.rst

+gui Package
+===========
+
+:mod:`gui` Package
+------------------
+
+.. automodule:: ars.gui
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.lib.pydispatch.rst

+pydispatch Package
+==================
+
+:mod:`pydispatch` Package
+-------------------------
+
+.. automodule:: ars.lib.pydispatch
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`dispatcher` Module
+------------------------
+
+.. automodule:: ars.lib.pydispatch.dispatcher
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`errors` Module
+--------------------
+
+.. automodule:: ars.lib.pydispatch.errors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`robust` Module
+--------------------
+
+.. automodule:: ars.lib.pydispatch.robust
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`robustapply` Module
+-------------------------
+
+.. automodule:: ars.lib.pydispatch.robustapply
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`saferef` Module
+---------------------
+
+.. automodule:: ars.lib.pydispatch.saferef
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ars.lib.pydispatch.tests
+

docs/sphinx/source/apidoc/ars.lib.pydispatch.tests.rst

+tests Package
+=============
+
+:mod:`tests` Package
+--------------------
+
+.. automodule:: ars.lib.pydispatch.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_dispatcher` Module
+-----------------------------
+
+.. automodule:: ars.lib.pydispatch.tests.test_dispatcher
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_robustapply` Module
+------------------------------
+
+.. automodule:: ars.lib.pydispatch.tests.test_robustapply
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`test_saferef` Module
+--------------------------
+
+.. automodule:: ars.lib.pydispatch.tests.test_saferef
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.lib.rst

+lib Package
+===========
+
+:mod:`lib` Package
+------------------
+
+.. automodule:: ars.lib
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ars.lib.pydispatch
+

docs/sphinx/source/apidoc/ars.model.collision.rst

+collision Package
+=================
+
+:mod:`adapters` Module
+----------------------
+
+.. automodule:: ars.model.collision.adapters
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`base` Module
+------------------
+
+.. automodule:: ars.model.collision.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.model.contrib.rst

+contrib Package
+===============
+
+:mod:`caster` Module
+--------------------
+
+.. automodule:: ars.model.contrib.caster
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`ragdoll` Module
+---------------------
+
+.. automodule:: ars.model.contrib.ragdoll
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.model.geometry.rst

+geometry Package
+================
+
+:mod:`geometry` Package
+-----------------------
+
+.. automodule:: ars.model.geometry
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.model.physics.rst

+physics Package
+===============
+
+:mod:`adapters` Module
+----------------------
+
+.. automodule:: ars.model.physics.adapters
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`base` Module
+------------------
+
+.. automodule:: ars.model.physics.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.model.robot.rst

+robot Package
+=============
+
+:mod:`robot` Package
+--------------------
+
+.. automodule:: ars.model.robot
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`actuators` Module
+-----------------------
+
+.. automodule:: ars.model.robot.actuators
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`joints` Module
+--------------------
+
+.. automodule:: ars.model.robot.joints
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`sensors` Module
+---------------------
+
+.. automodule:: ars.model.robot.sensors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.model.rst

+model Package
+=============
+
+:mod:`model` Package
+--------------------
+
+.. automodule:: ars.model
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ars.model.collision
+    ars.model.contrib
+    ars.model.geometry
+    ars.model.physics
+    ars.model.robot
+    ars.model.simulator
+

docs/sphinx/source/apidoc/ars.model.simulator.rst

+simulator Package
+=================
+
+:mod:`simulator` Package
+------------------------
+
+.. automodule:: ars.model.simulator
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/ars.rst

+ars Package
+===========
+
+:mod:`constants` Module
+-----------------------
+
+.. automodule:: ars.constants
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`exceptions` Module
+------------------------
+
+.. automodule:: ars.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    ars.app
+    ars.graphics
+    ars.gui
+    ars.lib
+    ars.model
+    ars.utils
+

docs/sphinx/source/apidoc/ars.utils.rst

+utils Package
+=============
+
+:mod:`containers` Module
+------------------------
+
+.. automodule:: ars.utils.containers
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`generic` Module
+---------------------
+
+.. automodule:: ars.utils.generic
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`geometry` Module
+----------------------
+
+.. automodule:: ars.utils.geometry
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+:mod:`mathematical` Module
+--------------------------
+
+.. automodule:: ars.utils.mathematical
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/apidoc/modules.rst

+ars
+===
+
+.. toctree::
+   :maxdepth: 4
+
+   ars
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.