Skip to content

Commit

Permalink
[feat]: updated doc deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
Vl-Tershch committed Jun 2, 2024
1 parent 2921ac1 commit 4a60753
Showing 1 changed file with 39 additions and 17 deletions.
56 changes: 39 additions & 17 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,49 @@
name: Documentation
name: docs_pages_workflow

on: [push, pull_request, workflow_dispatch]

permissions:
contents: write
on:
push:
branches: [ development, main ]

jobs:
docs:

build_docs_job:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}

steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
- name: Checkout
uses: actions/checkout@v2.3.4

- name: Set up Python
uses: actions/setup-python@v2.2.1
with:
python-version: 3.9

- name: Install dependencies
run: |
pip install sphinx sphinx_rtd_theme myst_parser
- name: Sphinx build
python -m pip install -U sphinx
python -m pip install sphinx-rtd-theme
- name: make the sphinx docs
run: |
sphinx-build docs _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
make -C docs clean
make -C docs html
- name: Init new repo in dist folder and commit generated files
run: |
cd docs/build/html/
git init
touch .nojekyll
git add -A
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git commit -m 'deploy'
- name: Force push to destination branch
uses: ad-m/github-push-action@v0.5.0
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true
branch: gh-pages
force: true
directory: ./docs/build/html

0 comments on commit 4a60753

Please sign in to comment.