47d7e9f3f6
## Summary Fixes some incorrectly formatted documentations, such as in the observation module. Also adds some missing module-level docstrings. Also adds a PrimAITE Favicon to docs. Removed Primaite-dependencies.rst as it's autogenerated. ## Test process Purely cosmetic, so functionality not tested. I did render the HTML output to observe that some mistakes have been fixed. ## Checklist - [x] This PR is linked to a **work item** - [x] I have performed **self-review** of the code - [na] I have written **tests** for any new functionality added with this PR - [x] I have updated the **documentation** if this PR changes or adds functionality - [ ] I have run **pre-commit** checks for code style Related work items: #1572
PrimAITE
Getting Started with PrimAITE
Pre-Requisites
In order to get PrimAITE installed, you will need to have the following installed:
python3.8+python3-pipvirtualenv
PrimAITE is designed to be OS-agnostic, and thus should work on most variations/distros of Linux, Windows, and MacOS.
Installation from source
1. Navigate to the PrimAITE folder and create a new python virtual environment (venv)
python3 -m venv <name_of_venv>
2. Activate the venv
Unix
source <name_of_venv>/bin/activate
Windows
.\<name_of_venv>\Scripts\activate
3. Install primaite into the venv along with all of it's dependencies
python3 -m pip install -e .
Development Installation
To install the development dependencies, postfix the command in step 3 above with the [dev] extra. Example:
python3 -m pip install -e .[dev]
Building documentation
The PrimAITE documentation can be built with the following commands:
Unix
cd docs
make html
Windows
cd docs
.\make.bat html
This will build the documentation as a collection of HTML files which uses the Read The Docs sphinx theme. Other build options are available but may require additional dependencies such as LaTeX and PDF. Please refer to the Sphinx documentation for your specific output requirements.