Skip to content

JAlvarezJarreta triggered mkdocs generation #84

JAlvarezJarreta triggered mkdocs generation

JAlvarezJarreta triggered mkdocs generation #84

# See the NOTICE file distributed with this work for additional information
# regarding copyright ownership.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
name: Documentation
run-name: ${{ github.actor }} triggered mkdocs generation
on:
pull_request:
types:
- closed
branches:
- main
- 'hackathon/**'
paths:
- 'src/python/ensembl/**'
- 'docs/**'
- '.github/workflows/mkdocs_docs_generation.yml'
workflow_dispatch:
env:
PYTHON_VERSION: "3.10"
jobs:
Mkdocs_Doc_generation:
name: Deploy documentation to GitHub Pages
if: github.event.pull_request.merged == true
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout Repository
uses: actions/checkout@v4
- name: Set up Python ${{ env.PYTHON_VERSION }}
uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[docs]
- name: Run mkdocs
run: |
mkdocs gh-deploy --force