docs: Simplify documentation site configuration and deployment

- Streamline MkDocs navigation structure
- Reduce complexity in GitHub Actions documentation workflow
- Update documentation dependencies and requirements
- Simplify site name and deployment configuration
This commit is contained in:
jango-blockchained
2025-02-05 23:29:50 +01:00
parent 039f6890a7
commit 4306a6866f
3 changed files with 18 additions and 61 deletions

View File

@@ -1,62 +1,26 @@
name: Deploy MkDocs name: Deploy Documentation
on: on:
push: push:
branches: branches:
- main - main
- master paths:
workflow_dispatch: # Allow manual trigger - 'docs/**'
- 'mkdocs.yml'
permissions:
contents: write
jobs: jobs:
deploy: deploy:
runs-on: ubuntu-latest runs-on: ubuntu-latest
permissions:
contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with: - uses: actions/setup-python@v5
fetch-depth: 0
- name: Setup Python
uses: actions/setup-python@v4
with: with:
python-version: '3.x' python-version: '3.x'
cache: 'pip' # Enable pip caching cache: 'pip'
- run: pip install -r docs/requirements.txt
- name: Cache MkDocs dependencies - name: Deploy Documentation
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Check links
run: |
mkdocs build --strict
- name: Test build
run: |
mkdocs build
if [ ! -d "site" ]; then
echo "Build failed - site directory not created"
exit 1
fi
- name: Deploy
run: | run: |
git config --global user.name "github-actions[bot]" git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com" git config --global user.email "github-actions[bot]@users.noreply.github.com"
mkdocs gh-deploy --force mkdocs gh-deploy --force
- name: Verify deployment
run: |
# Wait for GitHub Pages to update
sleep 30
# Check if the site is accessible
curl -s -f -o /dev/null "https://jango-blockchained.github.io/advanced-homeassistant-mcp" || exit 1

View File

@@ -1,4 +1,5 @@
mkdocs-material>=9.5.0 mkdocs>=1.5.0
mkdocs-material>=9.0.0
mkdocs-minify-plugin>=0.7.1 mkdocs-minify-plugin>=0.7.1
mkdocs-git-revision-date-plugin>=0.3.2 mkdocs-git-revision-date-plugin>=0.3.2
mkdocs-mkdocstrings>=0.24.0 mkdocs-mkdocstrings>=0.24.0
@@ -7,3 +8,4 @@ mkdocs-redirects>=1.2.1
mkdocs-glightbox>=0.3.4 mkdocs-glightbox>=0.3.4
pillow>=10.0.0 pillow>=10.0.0
cairosvg>=2.7.0 cairosvg>=2.7.0
pymdown-extensions>=10.0

View File

@@ -1,4 +1,4 @@
site_name: Advanced Home Assistant MCP site_name: Project Documentation
site_url: https://jango-blockchained.github.io/advanced-homeassistant-mcp site_url: https://jango-blockchained.github.io/advanced-homeassistant-mcp
repo_url: https://github.com/jango-blockchained/advanced-homeassistant-mcp repo_url: https://github.com/jango-blockchained/advanced-homeassistant-mcp
@@ -61,21 +61,12 @@ plugins:
nav: nav:
- Home: index.md - Home: index.md
- Getting Started: getting-started.md
- API Reference: api.md
- Usage: usage.md - Usage: usage.md
- Configuration: - Configuration:
- Claude Desktop Config: claude_desktop_config.md - Claude Desktop Config: claude_desktop_config.md
- Client Config: client_config.md - Client Config: client_config.md
- Getting Started:
- Overview: getting-started/index.md
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- Docker Setup: getting-started/docker.md
- Quick Start: getting-started/quickstart.md
- API Reference:
- Overview: api/index.md
- Core API: api/core-api.md
- SSE API: api/sse.md
- Core Functions: api/core.md
- Tools: - Tools:
- Overview: tools/tools.md - Overview: tools/tools.md
- Device Management: - Device Management: