Documentation added
This commit is contained in:
51
mkdocs.yml
Normal file
51
mkdocs.yml
Normal file
@@ -0,0 +1,51 @@
|
||||
site_name: pyappengine
|
||||
site_description: Python Application Engine — modular command-based application framework
|
||||
site_author: François Dausseur
|
||||
repo_url: https://git.beafrancois.fr/Foue/pyappengine
|
||||
repo_name: pyappengine
|
||||
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
- scheme: default
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
- scheme: slate
|
||||
primary: indigo
|
||||
accent: indigo
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to light mode
|
||||
features:
|
||||
- navigation.sections
|
||||
- navigation.top
|
||||
- search.suggest
|
||||
- content.code.copy
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- mkdocstrings:
|
||||
handlers:
|
||||
python:
|
||||
options:
|
||||
show_source: true
|
||||
show_root_heading: true
|
||||
docstring_style: google
|
||||
members_order: source
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
- Getting started: getting-started.md
|
||||
- API Reference: api.md
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- pymdownx.highlight:
|
||||
anchor_linenums: true
|
||||
- pymdownx.superfences
|
||||
- pymdownx.inlinehilite
|
||||
- toc:
|
||||
permalink: true
|
||||
Reference in New Issue
Block a user