Major overhaul:
- transition to `pyproject.toml` config - include license (Apache-2.0) - add dev tools - add documentation config (`mkdocs` based) - turn `README.md` into a symlink to docs `index.md` - add convenience scripts for testing and linting
This commit is contained in:
+38
@@ -0,0 +1,38 @@
|
||||
copyright: "© 2023 ${REPO_OWNER_TITLE}"
|
||||
site_name: "${REPO_NAME}"
|
||||
site_description: "${REPO_DESCRIPTION}"
|
||||
site_url: "http://${REPO_OWNER_LOWER}.github.io/${REPO_NAME_LOWER}"
|
||||
repo_name: "${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}"
|
||||
repo_url: "https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}"
|
||||
|
||||
theme:
|
||||
language: en
|
||||
name: material
|
||||
palette:
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
accent: red
|
||||
toggle:
|
||||
icon: material/brightness-7
|
||||
name: Switch to dark mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
accent: red
|
||||
toggle:
|
||||
icon: material/brightness-4
|
||||
name: Switch to light mode
|
||||
extra_css:
|
||||
- css/extra.css
|
||||
|
||||
plugins:
|
||||
- search
|
||||
- mkdocstrings
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- codehilite
|
||||
- extra
|
||||
- pymdownx.superfences
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
Reference in New Issue
Block a user