| site_name: makefun | |
| # site_description: 'A short description of my project' | |
| repo_url: https://github.com/smarie/python-makefun | |
| # docs_dir: docs | |
| # site_dir: ../site | |
| # default branch is main instead of master now on github | |
| edit_uri : ./edit/main/docs | |
| nav: | |
| - Home: index.md | |
| - API reference: api_reference.md | |
| - Changelog: changelog.md | |
| # - Advanced Usage: advanced_usage.md | |
| theme: material # readthedocs mkdocs | |
| markdown_extensions: | |
| - pymdownx.highlight # see https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#highlight | |
| - pymdownx.superfences # same as above as well as code blocks inside other blocks | |
| - admonition # to add notes such as http://squidfunk.github.io/mkdocs-material/extensions/admonition/ | |
| # - codehilite: | |
| # guess_lang: false | |
| - toc: | |
| permalink: true | |