309556c1a0
- Remove manual API docs (mkdocstrings generates automatically) - Remove internal docs (ARCHITECTURE, GITEA_PAGES, RELEASE, SEMANTIC_RELEASE) - Add usage.md with examples - Simplify index.md - Update mkdocs.yml (minimal config) - Remove api_reference.md duplicate
76 lines
1.7 KiB
YAML
76 lines
1.7 KiB
YAML
site_name: Kwork API
|
|
site_description: Unofficial Python client for Kwork.ru API
|
|
site_url: https://git.much-data.ru/much-data/kwork-api
|
|
|
|
repo_name: much-data/kwork-api
|
|
repo_url: https://git.much-data.ru/much-data/kwork-api
|
|
|
|
theme:
|
|
name: material
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- toc.integrate
|
|
- search.suggest
|
|
- search.highlight
|
|
palette:
|
|
- scheme: default
|
|
toggle:
|
|
icon: material/toggle-switch-off-outline
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
toggle:
|
|
icon: material/toggle-switch
|
|
name: Switch to light mode
|
|
|
|
plugins:
|
|
- search
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
paths: [src]
|
|
options:
|
|
docstring_style: google
|
|
show_source: true
|
|
show_root_heading: true
|
|
show_category_heading: true
|
|
merge_init_into_class: true
|
|
separate_signature: true
|
|
signature_crossrefs: true
|
|
filters:
|
|
- "!^_"
|
|
- "^__init__"
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.arithmatex:
|
|
generic: true
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.details
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.magiclink:
|
|
repo_url_shorthand: true
|
|
user: much-data
|
|
repo: kwork-api
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- API Reference: api-reference.md
|
|
- Usage: usage.md
|