-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(mkdocs.yml): add mkdocs config and publish to gh pages
- Loading branch information
1 parent
e993b23
commit 045992a
Showing
2 changed files
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
|