disqualifier
142a0dbff6
- Pull the rethink lambda logo (assets/img/logo.svg) into docs/assets and wire it as theme.logo + favicon — matches the Gitea brand mark. - standards.md: fold six thin sections into three fuller ones (Files and style / Documentation / Quality and error handling), each illustrated with python snippets, a flake8 output block, Do/Don't tabbed examples, a traceback, and a log line. Admonitions for the run-it-locally tip and the lib-logging note. - libraries.md: add a collapsible 'using a library' example (pyproject pin + import/usage python snippet). Verified in-browser: logo renders in the header, snippets/tabs/traceback/ log blocks render against the dark theme, libraries example expands. mkdocs build --strict clean. Signed-off-by: disqualifier <dev@disqualifier.me>
58 lines
1.2 KiB
YAML
58 lines
1.2 KiB
YAML
site_name: a rethink development
|
|
site_description: Libraries, coding standards, and how to deploy on our network.
|
|
site_url: https://docs.rethinkstudios.io/
|
|
copyright: rethink development
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
theme:
|
|
name: material
|
|
language: en
|
|
logo: assets/logo.svg
|
|
favicon: assets/logo.svg
|
|
palette:
|
|
scheme: slate
|
|
primary: custom
|
|
accent: custom
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.top
|
|
- toc.follow
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
icon:
|
|
repo: fontawesome/brands/git-alt
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
|
|
plugins:
|
|
- search
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Libraries: libraries.md
|
|
- Standards: standards.md
|
|
- Workflow: workflow.md
|
|
- Deploy: deploy.md
|