Merge remote-tracking branch 'origin/develop' into production

Author: PeterKeffer

docs/README.md

@@ -1,6 +1,6 @@
-# Create Automatic Documentation for the Peter Algorithm with Sphinx
+# Create Automatic Documentation for the PITA Algorithm with Sphinx
 
-The documentation for the Peter Algorithm can be generated automatically using Sphinx, a powerful documentation generation tool for Python. For a high quality result, proper doc-strings are essential since Sphinx uses them to generate the documentation.
+The documentation for the PITA Algorithm can be generated automatically using Sphinx, a powerful documentation generation tool for Python. For a high quality result, proper doc-strings are essential since Sphinx uses them to generate the documentation.
 
 ## Installation
 
@@ -16,10 +16,10 @@ To create the documentation, follow these steps:
 1. From within the root directory of the project run `sphinx-quickstart docs`. Answer "yes" to the first prompt and customize the rest according to your preferences.
 2. After running the quickstart command, generate the documentation by running `sphinx-build -b html docs/source/ docs/build/html`. This will generate the necessary files for the documentation in the "build" and "source" folders.
 3. Configure the `conf.py` file in the "docs/source":
-    - Add the `peters_algorithm` folder to the system path
+    - Add the `pita_algorithm` folder to the system path
     - Apply the installed theme
     - Use relevant extensions such as 'sphinx.ext.duration', 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.autosummary', and 'sphinx.ext.viewcode'
-4. Run `sphinx-apidoc -M -P -e -d 5 -f -o docs/source/ peters_algorithm/` from the root folder to generate API documentation for the `peters_algorithm` module. The individual flags mean: 
+4. Run `sphinx-apidoc -M -P -e -d 5 -f -o docs/source/ pita_algorithm/` from the root folder to generate API documentation for the `pita_algorithm` module. The individual flags mean: 
     - -M: put module documentation before submodule documentation
     - -P: include “_private” modules
     - -e: put documentation for each module on its own page to correctly display .py files as submodules
@@ -30,8 +30,7 @@ To create the documentation, follow these steps:
 6. Open `docs/build/html/index.html` to view the generated documentation.
 
 ## Steps for Updating Documentation
-0. Only after the first pull of the repository (since the build folder is ignored by git), run `sphinx-build -b html docs/source/ docs/build/html` to generate the necessary files for the documentation in the "build" folder.
-1. Run `sphinx-apidoc -M -P -e -d 5 -f -o docs/source/ peters_algorithm/` from the root folder to generate API documentation for the `peters_algorithm` module.
+1. Run `sphinx-apidoc -M -P -e -d 5 -f -o docs/source/ pita_algorithm/` from the root folder to generate API documentation for the `pita_algorithm` module.
 2. Run `make html` from within the "docs" folder to generate the HTML files.
 3. Open `docs/build/html/index.html` to view the generated documentation.
 

docs/build/doctrees/environment.pickle

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 8584697138549918ce8720dd45c3ab5a
+config: 55b04df860f88de021d9826d3a0cc08e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/doctrees/index.doctree

@@ -101,7 +101,7 @@
                                 <p class="caption" role="heading"><span class="caption-text">PITA Algorithm Docs</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../modules.html">API Reference</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="../peters_algorithm.html">peters_algorithm package</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../pita_algorithm.html">pita_algorithm package</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference external" href="https://github.com/microcosmAI/s.peters_algorithm/issues">Open Issues</a></li>
@@ -123,24 +123,26 @@
 
   <h1>All modules for which code is available</h1>
 <ul><li><a href="_abc.html">_abc</a></li>
-<li><a href="peters_algorithm/base/assembler.html">peters_algorithm.base.assembler</a></li>
-<li><a href="peters_algorithm/base/asset_parsing/mujoco_loader.html">peters_algorithm.base.asset_parsing.mujoco_loader</a></li>
-<li><a href="peters_algorithm/base/asset_parsing/mujoco_object.html">peters_algorithm.base.asset_parsing.mujoco_object</a></li>
-<li><a href="peters_algorithm/base/asset_parsing/parser.html">peters_algorithm.base.asset_parsing.parser</a></li>
-<li><a href="peters_algorithm/base/asset_placement/abstract_placer.html">peters_algorithm.base.asset_placement.abstract_placer</a></li>
-<li><a href="peters_algorithm/base/asset_placement/abstract_rule.html">peters_algorithm.base.asset_placement.abstract_rule</a></li>
-<li><a href="peters_algorithm/base/asset_placement/border_placer.html">peters_algorithm.base.asset_placement.border_placer</a></li>
-<li><a href="peters_algorithm/base/asset_placement/boundary_rule.html">peters_algorithm.base.asset_placement.boundary_rule</a></li>
-<li><a href="peters_algorithm/base/asset_placement/fixed_placer.html">peters_algorithm.base.asset_placement.fixed_placer</a></li>
-<li><a href="peters_algorithm/base/asset_placement/min_distance_rule.html">peters_algorithm.base.asset_placement.min_distance_rule</a></li>
-<li><a href="peters_algorithm/base/asset_placement/random_placer.html">peters_algorithm.base.asset_placement.random_placer</a></li>
-<li><a href="peters_algorithm/base/asset_placement/validator.html">peters_algorithm.base.asset_placement.validator</a></li>
-<li><a href="peters_algorithm/base/world_container/abstract_container.html">peters_algorithm.base.world_container.abstract_container</a></li>
-<li><a href="peters_algorithm/base/world_container/area.html">peters_algorithm.base.world_container.area</a></li>
-<li><a href="peters_algorithm/base/world_container/environment.html">peters_algorithm.base.world_container.environment</a></li>
-<li><a href="peters_algorithm/pita.html">peters_algorithm.pita</a></li>
-<li><a href="peters_algorithm/utils/config_reader.html">peters_algorithm.utils.config_reader</a></li>
-<li><a href="peters_algorithm/utils/json_exporter.html">peters_algorithm.utils.json_exporter</a></li>
+<li><a href="pita_algorithm/base/assembler.html">pita_algorithm.base.assembler</a></li>
+<li><a href="pita_algorithm/base/asset_parsing/mujoco_loader.html">pita_algorithm.base.asset_parsing.mujoco_loader</a></li>
+<li><a href="pita_algorithm/base/asset_parsing/mujoco_object.html">pita_algorithm.base.asset_parsing.mujoco_object</a></li>
+<li><a href="pita_algorithm/base/asset_parsing/parser.html">pita_algorithm.base.asset_parsing.parser</a></li>
+<li><a href="pita_algorithm/base/asset_placement/abstract_placer.html">pita_algorithm.base.asset_placement.abstract_placer</a></li>
+<li><a href="pita_algorithm/base/asset_placement/abstract_rule.html">pita_algorithm.base.asset_placement.abstract_rule</a></li>
+<li><a href="pita_algorithm/base/asset_placement/border_placer.html">pita_algorithm.base.asset_placement.border_placer</a></li>
+<li><a href="pita_algorithm/base/asset_placement/boundary_rule.html">pita_algorithm.base.asset_placement.boundary_rule</a></li>
+<li><a href="pita_algorithm/base/asset_placement/fixed_placer.html">pita_algorithm.base.asset_placement.fixed_placer</a></li>
+<li><a href="pita_algorithm/base/asset_placement/min_distance_mujoco_physics_rule.html">pita_algorithm.base.asset_placement.min_distance_mujoco_physics_rule</a></li>
+<li><a href="pita_algorithm/base/asset_placement/min_distance_rule.html">pita_algorithm.base.asset_placement.min_distance_rule</a></li>
+<li><a href="pita_algorithm/base/asset_placement/random_placer.html">pita_algorithm.base.asset_placement.random_placer</a></li>
+<li><a href="pita_algorithm/base/asset_placement/validator.html">pita_algorithm.base.asset_placement.validator</a></li>
+<li><a href="pita_algorithm/base/world_sites/abstract_site.html">pita_algorithm.base.world_sites.abstract_site</a></li>
+<li><a href="pita_algorithm/base/world_sites/area.html">pita_algorithm.base.world_sites.area</a></li>
+<li><a href="pita_algorithm/base/world_sites/environment.html">pita_algorithm.base.world_sites.environment</a></li>
+<li><a href="pita_algorithm/pita.html">pita_algorithm.pita</a></li>
+<li><a href="pita_algorithm/utils/config_reader.html">pita_algorithm.utils.config_reader</a></li>
+<li><a href="pita_algorithm/utils/json_exporter.html">pita_algorithm.utils.json_exporter</a></li>
+<li><a href="pita_algorithm/utils/multivariate_uniform_distribution.html">pita_algorithm.utils.multivariate_uniform_distribution</a></li>
 </ul>