Skip to content

Commit 1402ffe

Browse files
YosefAshenaficlaude
andcommitted
docs: setup mkdocs documentation with configuration and build scripts
Adds mkdocs configuration and documentation infrastructure: - mkdocs.yml: MkDocs site configuration - docs/: Documentation markdown files and index - .github/workflows/deploy-docs.yml: GitHub Actions workflow for automated deployment - build-docs.sh: Documentation build script - serve-docs.sh: Local documentation server script - logo.png: Documentation site logo 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent d60ef64 commit 1402ffe

24 files changed

+234
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
- main
8+
paths:
9+
- 'README.md'
10+
- '*/README.md'
11+
- 'mkdocs.yml'
12+
- 'docs/**'
13+
- '.github/workflows/deploy-docs.yml'
14+
15+
jobs:
16+
build-and-deploy:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout repository
20+
uses: actions/checkout@v4
21+
22+
- name: Set up Python
23+
uses: actions/setup-python@v4
24+
with:
25+
python-version: '3.11'
26+
27+
- name: Install dependencies
28+
run: |
29+
pip install mkdocs mkdocs-material
30+
31+
- name: Build documentation
32+
run: |
33+
bash build-docs.sh
34+
35+
- name: Deploy to GitHub Pages
36+
uses: peaceiris/actions-gh-pages@v3
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: ./site

build-docs.sh

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
#!/bin/bash
2+
# Build script for mkdocs documentation
3+
# This script copies README files into docs/ and builds the site
4+
5+
set -e
6+
7+
echo "Setting up documentation files..."
8+
9+
# Create docs directory
10+
mkdir -p docs
11+
12+
# Copy README files with appropriate names
13+
cp README.md docs/index.md
14+
cp admin/README.md docs/admin.md
15+
cp admintools/README.md docs/admintools.md
16+
cp api/README.md docs/api.md
17+
cp cache/README.md docs/cache.md
18+
cp constants/README.md docs/constants.md
19+
cp decorators/README.md docs/decorators.md
20+
cp extensions/README.md docs/extensions.md
21+
cp forms/README.md docs/forms.md
22+
cp middleware/README.md docs/middleware.md
23+
cp models/README.md docs/models.md
24+
cp utils/README.md docs/utils.md
25+
cp validators/README.md docs/validators.md
26+
cp apps/README.md docs/apps.md
27+
cp lib/README.md docs/lib.md
28+
cp test_scaffold/README.md docs/test_scaffold.md
29+
cp scripts/README.md docs/scripts.md
30+
cp templatetags/README.md docs/templatetags.md
31+
32+
echo "✓ Documentation files copied"
33+
34+
# Build the site
35+
echo "Building documentation site..."
36+
mkdocs build
37+
38+
echo "✓ Documentation built successfully"
39+
echo "✓ Site output is in the 'site/' directory"

docs/admin.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../admin/README.md

docs/admintools.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../admintools/README.md

docs/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../api/README.md

docs/apps.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../apps/README.md

docs/cache.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../cache/README.md

docs/constants.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../constants/README.md

docs/decorators.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../decorators/README.md

docs/extensions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../extensions/README.md

0 commit comments

Comments
 (0)