Skip to content

Commit c398c44

Browse files
committed
docs: migrate from MkDocs to Sphinx with Furo theme
- Replace MkDocs with Sphinx using myst-parser for Markdown support - Use Furo theme for improved navigation and appearance - Add development workflow documentation page - Merge advanced configuration into settings page - Move DaisyUI documentation from usage to settings - Remove redundant sections (debugging guide, testing strategies, etc.) - Fix badge display in README with inline HTML and flex styles - Exclude docs/ from uv-secure pre-commit hook - Update justfile and .readthedocs.yml for Sphinx
1 parent f333c99 commit c398c44

18 files changed

Lines changed: 479 additions & 1102 deletions

.pre-commit-config.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ repos:
4343
rev: 0.15.4
4444
hooks:
4545
- id: uv-secure
46+
exclude: ^docs/
4647

4748
- repo: https://github.com/RobertCraigie/pyright-python
4849
rev: v1.1.407

.readthedocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ build:
77
tools:
88
python: "3.12"
99

10-
mkdocs:
11-
configuration: mkdocs.yml
10+
sphinx:
11+
configuration: docs/conf.py
1212

1313
# Optionally declare the Python requirements required to build your docs
1414
python:
1515
install:
16-
- requirements: docs/requirements.txt
16+
- requirements: docs/requirements.txt

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
- **Django support**: Dropped support for Django 5.1 (now supporting Django 4.2 LTS, 5.2, and 6.0 only)
77
- **Pre-commit hooks**: Updated uv-secure (0.15.4) and pyright (1.1.407)
88
- **Security**: Updated Django and Werkzeug to fix security vulnerabilities
9+
- **Documentation**: Migrated from MkDocs to Sphinx with myst-parser and Furo theme
10+
- **Documentation**: Added Advanced Configuration and Development Workflow pages
911

1012
### 🛠️ Developer Experience
1113
- **Cleanup command**: Added `just clean` target to remove temporary files and build artifacts

0 commit comments

Comments
 (0)