- Python 64.8%
- Makefile 35.2%
| hooks | first commit | |
| {{cookiecutter.__project_slug}} | update for licence and badge changes | |
| .darglint | first commit | |
| .flake8 | first commit | |
| .gitignore | first commit | |
| .pre-commit-config.yaml | first commit | |
| cookiecutter.json | first commit | |
| LICENSE | first commit | |
| poetry.lock | first commit | |
| pyproject.toml | first commit | |
| README.md | update for licence and badge changes | |
Cookiecutter Documentation Template
License
pre-commit enabled
Black codestyle
Cookiecutter template for configuring a basic documentation repository with sane defaults for MkDocs with MkDocs Material.
It is designed to fit with a Codeberg repository and associated Pages static site hosting setup. Adjust as necessary for your own provider.
Usage
Ensure you have cookiecutter installed first.
python3 -m pip install cookiecutter
Now use the template to create a new project and follow the prompts.
➜ python3 -m cookiecutter https://codeberg.org/mentor/docs-cookiecutter
The template supports Python 3.7, 3.8, 3.9, and 3.10.
Viewing the Docs
Using the provided makefile we can quickly generate the documentation for the project and then view it in a browser. This uses the mkdocs and mike packages and will live reload upon any changes to files within the docs directory.
make docs-dev
Publishing the Docs
If happy with the docs, use the make docs-publish command which will synchronise the main branch with the default site a user lands on and all other branches will get their own alias.