Fortuno documentation

This repository contains the user documentation of the Fortuno unit testing framework. Its content is rendered at the Fortuno documentation site.

License

Fortuno documentation is licensed under the Creative Common Attribution 4.0 International (CC BY 4.0) license.

Building the documentation locally

To build the documentation locally, follow these steps:

1. Create and activate a Python virtual environment:

   $ python3 -m venv venv
   $ source venv/bin/activate

2. Install the required dependencies (sphinx):

   $ pip install -r docs/requirements.txt

3. Build the documentation using the Makefile in the docs directory:

   $ cd docs
   $ make html

4. View the generated documentation in your browser:

   Simply open the generated html located at docs/_build/html/index.html.