- Snake-case for all files and folders (e.g.,
my_file.py,my_folder)
[optional issue id]: <description>
[optional body]
[optional footer(s)]
Examples:
* [`#19`] - Add the operator precedence examples
* [`#####`] - Move the image assets to a dedicated folder
Follow these steps to generate the static documentation using MkDocs.
- Install the required Python packages:
pip install -r requirements.txt
- Build the site:
The generated files will appear in the
mkdocs build
site/directory. - To preview the documentation locally, run:
mkdocs serve
Navigation is created automatically by the mkdocs-awesome-pages-plugin based on
files inside the docs/ folder.