Skip to content

Commit

Permalink
Documentation placeholder
Browse files Browse the repository at this point in the history
  • Loading branch information
AfonsoFGarcia committed Sep 4, 2023
1 parent 1cb6a0f commit c7bf522
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 0 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/docs-publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Publish Documentation

on:
release:
types: [published]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
docs:
name: Publish Documentation
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Pages
uses: actions/configure-pages@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs
- name: Copy README to index
run: |
rm docs/index.md
cp README.md docs/index.md
- name: Build docs
run: python -m mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: site/

deploy:
name: Deploy Documentation
runs-on: ubuntu-latest
needs: docs

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# HASS BlueCon

PLACEHOLDER FOR README
Empty file added docs/quickstart.md
Empty file.
16 changes: 16 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
site_name: BlueCon Home Assistant Integration
site_url: https://hass-bluecon.afonsogarcia.dev/
repo_url: https://github.com/AfonsoFGarcia/hass-bluecon

theme:
name: readthedocs
include_homepage_in_sidebar: false
prev_next_buttons_location: none
collapse_navigation: false

nav:
- Quickstart: quickstart.md

markdown_extensions:
- toc:
permalink: "#"

0 comments on commit c7bf522

Please sign in to comment.