Skip to content

Commit 15a18d2

Browse files
committed
feat: add docs
1 parent 35cc98a commit 15a18d2

20 files changed

+6297
-0
lines changed

.github/workflows/docs.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'docs/**'
9+
- 'mkdocs.yml'
10+
- '.github/workflows/docs.yml'
11+
pull_request:
12+
branches:
13+
- main
14+
paths:
15+
- 'docs/**'
16+
- 'mkdocs.yml'
17+
- '.github/workflows/docs.yml'
18+
workflow_dispatch:
19+
20+
permissions:
21+
contents: write
22+
23+
jobs:
24+
deploy:
25+
runs-on: ubuntu-latest
26+
steps:
27+
- name: Checkout repository
28+
uses: actions/checkout@v4
29+
with:
30+
fetch-depth: 0
31+
32+
- name: Set up Python
33+
uses: actions/setup-python@v5
34+
with:
35+
python-version: '3.x'
36+
37+
- name: Cache dependencies
38+
uses: actions/cache@v3
39+
with:
40+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
41+
path: ~/.cache/pip
42+
restore-keys: |
43+
${{ runner.os }}-pip-
44+
45+
- name: Install dependencies
46+
run: |
47+
pip install mkdocs-material
48+
pip install mkdocs-glightbox
49+
50+
- name: Build documentation
51+
run: mkdocs build --strict
52+
53+
- name: Deploy to GitHub Pages
54+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
55+
run: mkdocs gh-deploy --force

.gitignore

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# MkDocs
2+
site/
3+
.cache/
4+
5+
# Python
6+
__pycache__/
7+
*.py[cod]
8+
*$py.class
9+
*.so
10+
.Python
11+
venv/
12+
ENV/
13+
env/
14+
15+
# Terraform
16+
.terraform/
17+
*.tfstate
18+
*.tfstate.*
19+
*.tfvars
20+
.terraform.lock.hcl
21+
terraform.tfplan
22+
plan.tfplan
23+
24+
# Sensitive files
25+
*.pem
26+
*.key
27+
28+
# OS
29+
.DS_Store
30+
Thumbs.db
31+
32+
# IDE
33+
.vscode/
34+
.idea/
35+
*.swp
36+
*.swo
37+
*~
38+
39+
venv

docs/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github-org-management.automationdojo.org

0 commit comments

Comments
 (0)