Nikolay Tatarinov
e6bc60b436
Some checks failed
CI / lint-and-test (push) Failing after 23s
- Added *.egg-info/ to .gitignore to prevent egg metadata from being tracked. - Updated virtual environment instructions in CONTRIBUTING.md and README.md to use .venv for consistency. - Revised mkdocs.yml to include a placeholder for the repository URL when publishing. - Cleaned up pyproject.toml by removing unnecessary pylint configuration. - Enhanced import-format.md and runbook.md documentation for clarity on user roles and health check endpoints.
31 lines
785 B
YAML
31 lines
785 B
YAML
# MkDocs configuration for Duty Teller documentation.
|
|
# Build: mkdocs build. Preview: mkdocs serve.
|
|
site_name: Duty Teller
|
|
site_description: Telegram bot for team duty shift calendar and group reminder
|
|
# Set to your repository URL when publishing (placeholder below).
|
|
site_url: https://github.com/your-org/duty-teller
|
|
|
|
docs_dir: docs
|
|
theme:
|
|
name: material
|
|
language: en
|
|
|
|
plugins:
|
|
- search
|
|
- mkdocstrings:
|
|
handlers:
|
|
python:
|
|
options:
|
|
docstring_style: google
|
|
show_source: true
|
|
show_root_heading: true
|
|
heading_level: 2
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Configuration: configuration.md
|
|
- Architecture: architecture.md
|
|
- Import format: import-format.md
|
|
- Runbook: runbook.md
|
|
- API Reference: api-reference.md
|