Skip to content
Generate docs

Generate docs #1

Sign in to view logs

Generate docs

Generate docs #1

Workflow file for this run

.github/workflows/on_release_docs.yml at a0dc899
name: Generate docs
concurrency:
group: generate_docs
cancel-in-progress: true
on:
release:
types: [published]
workflow_dispatch: {}
jobs:
build-docs:
name: Build docs
runs-on: ubuntu-latest
env:
MAIN_BRANCH: main
steps:
- name: Checkout main branch
uses: actions/checkout@v4
with:
ref: ${{ env.MAIN_BRANCH }}
- name: Set up git
run: |
git config --global user.email "[email protected]"
git config --global user.name "github-actions"
- name: Create gh-pages branch if not exists
run: |
GIT_URL=`git config --get remote.origin.url`
GH_PAGES_BRANCH=`git ls-remote --heads ${GIT_URL} gh-pages`
if [[ "${GH_PAGES_BRANCH}" == "" ]]; then
echo "creating gh-pages branch"
git symbolic-ref HEAD refs/heads/gh-pages
rm .git/index
git clean -fdx
echo "Placeholder" > index.html
git add .
git commit -am "First pages commit"
git push origin gh-pages
echo "gh-pages branch created"
git checkout ${MAIN_BRANCH}
fi
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install project
run: |
python -m pip install poetry pip
poetry config virtualenvs.create false
poetry install -n
- name: Install handsdown
run: |
python -m pip install -U handsdown mkdocs mkdocs-material
- name: Build docs
run: |
python -m handsdown --external `git config --get remote.origin.url` -o docsmd --cleanup --panic --theme material --branch main $@
rm -rf docs/*
python -m mkdocs build
- name: Checkout gh-pages branch
uses: actions/checkout@v4
with:
ref: gh-pages
path: ./gh-pages
fetch-depth: 0
- name: Commit changes
run: |
cd ./gh-pages
rm -rf docs docsmd || true
mv ../docs .
mv ../docsmd .
git add docs
git add docsmd
git commit -am "Update docs"
git push