46b2f17acc
- Add MkDocs Material docs build stage to Dockerfile and Dockerfile.local - Mount pre-built docs as static files at /help/ in FastAPI (app/main.py) - Add app/views/help.py with /help → /help/ permanent redirect route - Register help router in app/views/__init__.py - Add Help nav link to base.html (public + app nav, desktop + mobile) - Create how-to guides: HP printer, ScanSnap, watched folder, email ingestion, mobile scanning - Update mkdocs.yml with How-To Guides section and Material theme palette - Add optional docs service (squidfunk/mkdocs-material) to docker-compose.yaml with docs profile - Add mkdocs-material to requirements-dev.txt - Add /docs_build to .gitignore - Add tests for help view (8 tests, 100% coverage on help.py) Co-authored-by: christianlouis <361235+christianlouis@users.noreply.github.com>
40 lines
1.2 KiB
Plaintext
40 lines
1.2 KiB
Plaintext
# Development and testing dependencies
|
||
-r requirements.txt
|
||
|
||
# Testing
|
||
pytest>=8.0.0
|
||
pytest-cov>=4.1.0
|
||
pytest-asyncio>=0.23.0
|
||
pytest-mock>=3.12.0
|
||
pytest-timeout>=2.3.0 # Per-test timeout enforcement to prevent CI hangs
|
||
httpx>=0.26.0 # For async test client
|
||
testcontainers>=3.7.1 # For integration tests with real containers
|
||
fpdf2>=2.8.0 # For generating test PDF documents in integration tests
|
||
minio>=7.1.0 # For MinIO/S3 integration tests
|
||
redis>=4.5.0 # For Redis integration tests
|
||
boto3>=1.26.0 # For S3 integration tests
|
||
|
||
# Code quality
|
||
ruff>=0.3.0
|
||
mypy>=1.8.0
|
||
djlint>=1.36.0 # HTML template linter for accessibility and best practices
|
||
|
||
# Documentation (builds the embedded /help site via MkDocs Material)
|
||
mkdocs-material>=9.5.0 # MkDocs Material theme – same package used in docs/requirements.txt
|
||
|
||
# Type stubs for mypy
|
||
types-requests>=2.31.0
|
||
types-paramiko>=3.0.0
|
||
|
||
# Security scanning (Ruff includes most security checks from bandit)
|
||
pip-audit>=2.7.0 # Dependency vulnerability scanning against OSV/PyPA advisory databases
|
||
|
||
# Pre-commit hooks
|
||
pre-commit>=3.6.0
|
||
|
||
# License compliance
|
||
pip-licenses==5.5.1 # For license compliance checking
|
||
|
||
# Release automation
|
||
python-semantic-release>=9.0.0
|