mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
a6c28ea85a
Use the Python module sphinx-versioned-docs to get versioned docs. Currently, there is only a version for the HEAD of the master branch but release versions can be added later by specifying a release tag.
54 lines
1.8 KiB
YAML
54 lines
1.8 KiB
YAML
name: Build Python Sphinx Docs and push to gh-pages
|
|
|
|
on:
|
|
push:
|
|
branches: main
|
|
paths:
|
|
- 'python/**'
|
|
- '.github/workflows/python_sphinx_docs.yml'
|
|
pull_request:
|
|
branches: main
|
|
paths:
|
|
- 'python/**'
|
|
- '.github/workflows/python_sphinx_docs.yml'
|
|
permissions:
|
|
contents: write
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: checkout source code
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0 # Fetch all history for all tags and branches
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v4
|
|
with:
|
|
python-version: "3.11"
|
|
- name: Install poetry
|
|
uses: abatilo/actions-poetry@v2
|
|
- name: Install python dependencies
|
|
run: |
|
|
cd python/sphinx_docs
|
|
poetry install
|
|
- name: Build documentation
|
|
run: |
|
|
cd python
|
|
mkdir gh-pages
|
|
touch gh-pages/.nojekyll
|
|
cd sphinx_docs
|
|
# Currently we build only docs for the HEAD of the master branch
|
|
# Later we can add release tags to the list to get the docs for the releases
|
|
# For example: -b "main, release/2024.04/final" will build the docs for
|
|
# the main branch and the release/2024.04/final tag
|
|
poetry run sphinx-versioned -m master -b master --git-root ../../
|
|
- name: Copy documentation to gh-pages
|
|
run: |
|
|
cp -r python/sphinx_docs/docs/_build/* gh-pages/
|
|
- name: Deploy documentation
|
|
if: ${{ github.event_name == 'push' }}
|
|
uses: JamesIves/github-pages-deploy-action@v4
|
|
with:
|
|
branch: gh-pages
|
|
folder: python/gh-pages
|