diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index e748150..18f43a7 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,62 +1,26 @@ -name: Deploy MkDocs +name: Deploy Documentation on: push: branches: - main - - master - workflow_dispatch: # Allow manual trigger - -permissions: - contents: write + paths: + - 'docs/**' + - 'mkdocs.yml' jobs: deploy: runs-on: ubuntu-latest + permissions: + contents: write steps: - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Setup Python - uses: actions/setup-python@v4 + - uses: actions/setup-python@v5 with: python-version: '3.x' - cache: 'pip' # Enable pip caching - - - name: Cache MkDocs dependencies - 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 + cache: 'pip' + - run: pip install -r docs/requirements.txt + - name: Deploy Documentation run: | git config --global user.name "github-actions[bot]" git config --global user.email "github-actions[bot]@users.noreply.github.com" - 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 \ No newline at end of file + mkdocs gh-deploy --force \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt index 4b2f74d..3cfdaee 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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-git-revision-date-plugin>=0.3.2 mkdocs-mkdocstrings>=0.24.0 @@ -6,4 +7,5 @@ mkdocs-social-plugin>=0.1.1 mkdocs-redirects>=1.2.1 mkdocs-glightbox>=0.3.4 pillow>=10.0.0 -cairosvg>=2.7.0 \ No newline at end of file +cairosvg>=2.7.0 +pymdown-extensions>=10.0 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index dca284e..6c94bf6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,4 @@ -site_name: Advanced Home Assistant MCP +site_name: Project Documentation site_url: https://jango-blockchained.github.io/advanced-homeassistant-mcp repo_url: https://github.com/jango-blockchained/advanced-homeassistant-mcp @@ -61,21 +61,12 @@ plugins: nav: - Home: index.md + - Getting Started: getting-started.md + - API Reference: api.md - Usage: usage.md - Configuration: - Claude Desktop Config: claude_desktop_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: - Overview: tools/tools.md - Device Management: