docs

Documentation generator for the Diagho project.

Features

• Generates online documentation for the Diagho project from source files written in Markdown.
• Provides a Makefile with a set of tools to install a development environment and build the documentation.

Quick start

Download this repository and unzip it on your computer. You should rename the folder docs-main in docs.

Or clone the repository directly on your computer:

$ git clone git@github.com:DiaghoProject/docs.git

Make sure you have python3.9 installed on your machine, then run:

$ cd docs
$ make quickstart

Then, visit http://127.0.0.1:8000/ with your web browser.

Versioning

We use SemVer for versioning. See the CHANGELOG.md file for details.

Contributing

If you'd like to contribute, please raise an issue or fork the repository and use a feature branch. Pull requests are warmly welcome!

Licensing

The code in this project is licensed under MIT license. See the LICENSE file for details.

Contributors

• Julien Lebunetel - jlebunetel