Do you wonder how was this documentation created?¶
In this section you can find the technologies used to generate the documentation of the project. And a quickstart to run the local server in your machine.
MkDocs¶
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file. Start by reading the introductory tutorial, then check the User Guide for more information.
For full documentation visit mkdocs.org.
Material theme for MkDocs¶
Based in the Material Design principles and quiet a lot of customization settings available. For full documentation visit Material for MkDocs.
Plugins¶
MkDocs plugin that displays the last revision date of the current page of the documentation based on Git. The revision date will be displayed in ISO format (YYYY-mm-dd). If you need other date formats check out timvink's fork
Markdown extensions¶
Admonition notes
If you want to use the styling of these notes use the Admonition extension.
We also use permalink extension to improve the url generated by the docs.
Other useful extensions can be found in PyMdown Extensions
Folder trees¶
Folder trees have been generated with file-tree-generator VS Code extension.
Run the server in your local machine¶
If you have cloned the repo of the project and want to make changes to the docs reproduce the following steps:
Steps provided for Ubuntu 20.04 or higher
If you are using a different OS the commands provided may vary, make sure you find the apropiate commands for your OS on the Internet.
Install Python3 and Pip¶
If you're working with Ubuntu 20.04 Python3 its already installed with the OS. To install pip run:
sudo apt update
sudo apt install python3-pip
Install MkDocs¶
pip install mkdocs
Run the local server¶
In this folder, the project folder, run:
mkdocs serve