Development

Getting the repository

You can get the MAxPy source code by cloning it from the Github repository:

git clone https://github.com/MAxPy-Project/MAxPy
cd MAxPy

Installing the package locally

Once you have made the desired changes, you can install the package in the editable mode. Using this options, the package is installed on the system from the local repository. Just run the following command from the repository dir:

python -m pip install -e .

Building documentation

Whenever the documentation are edit and pushed into the Github repository, the documentation is automatically built and it becomes available at https://maxpy-project.github.io/MAxPy/.

However, you can also build locally the documentation before pushing it. Please follow the instructions bellow:

1. Install sphinx

   pip install sphinx sphinx_rtd_theme
   

2. Change to the directory where the MAxPy repository is located at and run the documentation build command:

   sphinx-build -b html docs/source/ docs/build/html
   

3. The HTML page will be available at docs/build/html/index.html

MAxPy’s internals

#TODO