Skip to content

Commit

Permalink
feat(mkdocs.yml): add mkdocs config and publish to gh pages
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnVonNeumann committed Nov 23, 2024
1 parent e993b23 commit 045992a
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Publish documentation

on:
push:
branches:
- master

jobs:

publish-documentation:
runs-on: ubuntu-latest
needs: update-cli-screenshots
steps:
- uses: actions/checkout@v4
with:
token: "${{ secrets.PERSONAL_ACCESS_TOKEN }}"
fetch-depth: 0
- name: Pull latest changes
run: |
git pull origin master
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.x"
- name: Install dependencies
run: |
python -m pip install -U mkdocs mkdocs-material
- name: Build docs
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
python -m mkdocs build
- name: Push doc to Github Page
uses: peaceiris/actions-gh-pages@v4
with:
personal_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
publish_branch: gh-pages
publish_dir: ./site
user_name: "github-actions[bot]"
user_email: "github-actions[bot]@users.noreply.github.com"
17 changes: 17 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
site_name: ZeroTwentyFifty - PACT Conformant Product Carbon Footprint Exchange Platform

theme:
name: "material"

repo_name: ZeroTwentyFifty/zero_twenty_fifty
repo_url: https://github.com/ZeroTwentyFifty/zero_twenty_fifty
site_author: ZeroTwentyFifty
site_description: Documentation for ZeroTwentyFifty's flagship OS solution to PACT Conformant Product Carbon Footprint Exchange
edit_uri: ""

nav:
- Introduction: "README.md"
- Migrations: "MIGRATIONS.md"
- Local Database Setup: "POSTGRES_LOCAL_DOCKER_SETUP.md"
- Testing from the CLI: "TESTING_FROM_CLI.md"

0 comments on commit 045992a

Please sign in to comment.