Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add initial doc workflow #1

Merged
merged 1 commit into from
Aug 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/workflows/build-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Docs

on:
push:
branches:
- master
- main
- "[0-9][0-9].[0-9]+.x"

pull_request:
branches:
- master
- main
- "[0-9][0-9].[0-9]+.x"

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install ".[doc]"

- name: Clone GH-Pages
if: github.event_name != "pull_request"
runs: |
git clone https://github.com/openml-labs/gama.git --single-branch --branch gh-pages docs/build/${{ github.ref }}

- name: Build Docs
run: |
sphinx-build docs/source docs/build/${{ }}

- name: Push GH-Pages
if: github.event_name != "pull_request"
runs: |
cd docs/build
git config user.name github-actions
git config user.email github-actions@github.com
git add ${{ github.ref }}
git commit -m "Autodeploy docs"
git push
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = "en"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand Down