Skip to content

Commit 41310ab

Browse files
docs: reorganize MkDocs configuration and enhance documentation infrastructure
1 parent 33973d0 commit 41310ab

10 files changed

Lines changed: 903 additions & 221 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ on:
77
- docs
88
paths:
99
- 'docs/**'
10-
- 'mkdocs.yml'
1110
- '.github/workflows/deploy-docs.yml'
1211

1312
permissions:
@@ -47,4 +46,4 @@ jobs:
4746
4847
- name: Deploy documentation
4948
run: |
50-
uv run --group docs mkdocs gh-deploy --force
49+
uv run --group docs mkdocs gh-deploy --force -f docs/mkdocs-full.yml

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ python:
3333
# builder: html
3434

3535
mkdocs:
36-
configuration: mkdocs.yml
36+
configuration: docs/mkdocs.yml
3737
fail_on_warning: false
3838

3939
# Search settings

Makefile

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -150,18 +150,43 @@ ci: ## Run CI pipeline locally
150150
$(MAKE) build
151151

152152
.PHONY: docs-serve
153-
docs-serve: ## Serve MkDocs documentation locally
153+
docs-serve: ## Serve MkDocs documentation locally (balanced mode)
154154
@echo "${BLUE}Serving documentation...${NC}"
155-
$(UV) run --group docs mkdocs serve
155+
$(UV) run --group docs mkdocs serve -f docs/mkdocs.yml
156+
157+
.PHONY: docs-serve-fast
158+
docs-serve-fast: ## Serve MkDocs documentation with fast build (for quick iterations)
159+
@echo "${BLUE}Serving documentation (fast mode)...${NC}"
160+
$(UV) run --group docs mkdocs serve -f docs/mkdocs-fast.yml
161+
162+
.PHONY: docs-serve-no-api
163+
docs-serve-no-api: ## Serve MkDocs documentation without API auto-generation (fastest)
164+
@echo "${BLUE}Serving documentation (no API generation)...${NC}"
165+
ENABLE_MKDOCSTRINGS=false $(UV) run --group docs mkdocs serve -f docs/mkdocs.yml
156166

157167
.PHONY: docs-build
158-
docs-build: ## Build MkDocs documentation
168+
docs-build: ## Build MkDocs documentation (balanced mode)
159169
@echo "${BLUE}Building documentation...${NC}"
160-
$(UV) run --group docs mkdocs build
170+
$(UV) run --group docs mkdocs build -f docs/mkdocs.yml
171+
172+
.PHONY: docs-build-fast
173+
docs-build-fast: ## Build MkDocs documentation with fast config
174+
@echo "${BLUE}Building documentation (fast mode)...${NC}"
175+
$(UV) run --group docs mkdocs build -f docs/mkdocs-fast.yml
176+
177+
.PHONY: docs-build-full
178+
docs-build-full: ## Build MkDocs documentation with full features (for production)
179+
@echo "${BLUE}Building documentation (full mode)...${NC}"
180+
$(UV) run --group docs mkdocs build -f docs/mkdocs-full.yml --clean
181+
182+
.PHONY: docs-time
183+
docs-time: ## Time the documentation build
184+
@echo "${BLUE}Timing documentation build...${NC}"
185+
time $(UV) run --group docs mkdocs build -f docs/mkdocs.yml
161186

162187
.PHONY: docs-deploy
163188
docs-deploy: ## Deploy MkDocs to GitHub Pages
164189
@echo "${BLUE}Deploying documentation...${NC}"
165-
$(UV) run --group docs mkdocs gh-deploy --force
190+
$(UV) run --group docs mkdocs gh-deploy --force -f docs/mkdocs-full.yml
166191

167192
.DEFAULT_GOAL := help

README.md

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,24 @@ ArchiPy is a Python framework designed to provide a standardized, scalable, and
2828

2929
## 📋 Table of Contents
3030

31-
- [Goals](#-goals)
32-
- [Features](#-features)
33-
- [Prerequisites](#-prerequisites)
34-
- [Installation](#-installation)
35-
- [Usage](#-usage)
36-
- [Development](#-development)
37-
- [Contributing](#-contributing)
38-
- [License](#-license)
39-
- [Sponsors](#-sponsors)
40-
- [Contact](#-contact)
41-
- [Links](#-links)
31+
- [ArchiPy - Architecture + Python](#archipy---architecture--python)
32+
- [**Structured Python Development Made Simple**](#structured-python-development-made-simple)
33+
- [📋 Table of Contents](#-table-of-contents)
34+
- [🎯 Goals](#-goals)
35+
- [✨ Features](#-features)
36+
- [🛠️ Prerequisites](#️-prerequisites)
37+
- [📥 Installation](#-installation)
38+
- [🎯 Usage](#-usage)
39+
- [Optional Dependencies](#optional-dependencies)
40+
- [🛠️ Development](#️-development)
41+
- [Quick Commands](#quick-commands)
42+
- [🤝 Contributing](#-contributing)
43+
- [📄 License](#-license)
44+
- [🙌 Sponsors](#-sponsors)
45+
- [📞 Contact](#-contact)
46+
- [🔗 Links](#-links)
47+
- [📚 Documentation](#-documentation)
48+
- [Quick Start](#quick-start)
4249

4350
---
4451

@@ -174,21 +181,27 @@ ArchiPy's documentation has been migrated from Sphinx to MkDocs for improved rea
174181
- **Improved Navigation**: Intuitive organization and search
175182
- **Clearer Examples**: Expanded code samples with explanations
176183
- **API Reference**: Auto-generated from source code docstrings
184+
- **Performance Optimized**: Multiple build modes for fast iteration
177185

178-
To run the documentation locally:
186+
### Quick Start
179187

180188
```bash
181189
# Install documentation dependencies
182190
uv sync --group docs
183191

184-
# Serve documentation locally
192+
# Fast mode for quick iterations (10-20s builds)
193+
make docs-serve-fast
194+
195+
# Balanced mode for regular work (30-60s builds)
185196
make docs-serve
186197

187-
# Build documentation
188-
make docs-build
198+
# Full production build (2-5min, all features)
199+
make docs-build-full
189200

190201
# Deploy to GitHub Pages
191202
make docs-deploy
192203
```
193204

205+
**See [DOCS_QUICKSTART.md](DOCS_QUICKSTART.md) for more commands and tips.**
206+
194207
[View the latest documentation](https://syntaxarc.github.io/ArchiPy/)

0 commit comments

Comments
 (0)