Build documentation

This documentation was built using Sphinx.

Build locally

The following commands can be used to create a Conda environment that contains all packages needed to build the documentation.

1. Install Miniconda3 (Conda 23.5.2 Python 3.11.3 released July 13, 2023)

2. Install dependencies

   1. Option 1: install environment from YAML environment file

      conda env create -f envs/motbxtools_doc.yml
      conda activate motbxtools_doc
      pip install -e .
      

   2. Option 2: install dependencies manually using Miniconda/Anaconda Prompt or terminal:

      conda create -n motbxtools_doc python=3.11
      conda activate motbxtools_doc
      conda install -c conda-forge furo
      conda install -c conda-forge jsonschema
      conda install -c conda-forge validators
      conda install -c anaconda requests
      conda install -c conda-forge pyyaml
      conda install -c conda-forge sphinx
      conda install -c conda-forge sphinx-argparse
      conda install -c anaconda graphviz
      pip install -e .
      

The HTML documentation can be built using:

make html

Deploy on GitHub pages

A GitHub action has been defined to build the documention and deploy it on GitHub pages. The action is defined in .github/workflows/documentation.yml and can be manually triggered via actions. it is also triggered when changes are made to files in doc/ or src/.