docs: Refine MkDocs configuration and GitHub Actions deployment

- Update site name, description, and documentation structure
- Enhance MkDocs theme features and navigation
- Modify documentation navigation to use nested structure
- Improve GitHub Actions workflow with more robust deployment steps
- Add site directory configuration for GitHub Pages
This commit is contained in:
jango-blockchained
2025-02-05 23:35:20 +01:00
parent 4306a6866f
commit 33defac76c
2 changed files with 28 additions and 18 deletions

View File

@@ -14,13 +14,21 @@ jobs:
contents: write contents: write
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-python@v5 - uses: actions/setup-python@v5
with: with:
python-version: '3.x' python-version: '3.x'
cache: 'pip' cache: 'pip'
- run: pip install -r docs/requirements.txt - name: Install dependencies
- name: Deploy Documentation run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Configure Git
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 - name: Build and Deploy
run: |
mkdocs build --strict
mkdocs gh-deploy --force --clean

View File

@@ -1,11 +1,23 @@
site_name: Project Documentation site_name: MCP Server for Home Assistant
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
site_description: Home Assistant MCP Server Documentation
# Add this to handle GitHub Pages serving from a subdirectory
site_dir: site/advanced-homeassistant-mcp
theme: theme:
name: material name: material
logo: assets/images/logo.png logo: assets/images/logo.png
favicon: assets/images/favicon.ico favicon: assets/images/favicon.ico
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
palette: palette:
- scheme: default - scheme: default
primary: indigo primary: indigo
@@ -19,18 +31,6 @@ theme:
toggle: toggle:
icon: material/brightness-4 icon: material/brightness-4
name: Switch to light mode name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.top
- search.suggest
- search.highlight
- content.code.copy
- content.tabs.link
- content.tooltips
- toc.integrate
markdown_extensions: markdown_extensions:
- pymdownx.highlight: - pymdownx.highlight:
@@ -61,8 +61,10 @@ plugins:
nav: nav:
- Home: index.md - Home: index.md
- Getting Started: getting-started.md - Getting Started:
- API Reference: api.md - Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- API Reference: api/index.md
- Usage: usage.md - Usage: usage.md
- Configuration: - Configuration:
- Claude Desktop Config: claude_desktop_config.md - Claude Desktop Config: claude_desktop_config.md