Follow the instructions here to install Anaconda or Miniconda.
Assure that your terminal prompt is now prefixed by the conda environment that is currently activated as bellow
(base) $
If you don't see the (base) text (indicating you are in the "base" conda environment), it is suggested that you follow this practice
If this is your first time setting up the repository you should use the following command to create the website's environment from file.
conda env create -f environment.yml
You should see a number of packages install using both conda and pip.
To activate, or enter, the newly created environment, you can use the following command.
NOTE: This will need to be each time you wish serve the documentation and open a new terminal.
conda activate mivp-agent-web
You should see this change in your environment in the conda's terminal prompt prefix.
If new dependencies are added to the environment.yml you can update your local environment by the use of the following command.
IMPORTANT NOTE: This should be run ONLY when the (mivp-agent-web) environment is activated.
conda env update -f environment.yml
This website uses mkdocstrings to generate API documentation for python. This package looks in the src/ directory for the python module. You must link your copy of the moos-ivp-agent/src/python_module directory to the src directory. For example I use the following command on OSX.
ln -s /Users/carter/src/moos-ivp-agent/src/python_module/mivp_agent /Users/carter/src/mivp-agent.github.io/mivp_agent
A local version of the documentation can be served through the following command in the root directory.
mkdocs serve
A static site can be build with the following command.
mkdocs build
- General
- Python API