Documentation development

This documentation is written using the Sphinx Python library. The theme Furo is used and each page is written with an extended MarkDown syntax called MyST.

Installation

To contribute to the development of the documentation, please set up the environment with the following commands. This will install Sphinx and related themes and libraries for this project.

conda activate airtrafficsim
conda install -c conda-forge sphinx myst-parser furo numpydoc sphinx-copybutton

Building and previewing documentation

A GitHub action is set up to automatically build and publish this documentation to the GitHub page. However, you may also want to preview the documentation during development.

First, you can build the documentation locally by executing the following commands.

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

Then, you may preview the documentation by executing the following commands.

python3 -m http.server 8000

This will open a Python server. Navigate to http://localhost:8000/docs/build/html in your browser to preview the website.