Skip to content

Commit

Permalink
Add reusable workflow for build_docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Matthias Wittgen committed Jun 4, 2022
1 parent 31b4056 commit 3a3e107
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 45 deletions.
48 changes: 3 additions & 45 deletions .github/workflows/build_docs.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: docs
name: Build docs

on:
push:
Expand All @@ -7,47 +7,5 @@ on:
pull_request:

jobs:
build_sphinx_docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
# Need to clone everything for the git tags.
fetch-depth: 0

- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: '3.10'
cache: "pip"
cache-dependency-path: "setup.cfg"

- name: Install sqlite
run: sudo apt-get install sqlite libyaml-dev

- name: Update pip/wheel infrastructure
run: |
python -m pip install --upgrade pip
pip install wheel
- name: Install postgresql (server)
run: |
sudo apt-get update
sudo apt-get install postgresql
- name: Install postgresql Python packages
run: pip install psycopg2 testing.postgresql

- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Build and install
run: pip install -v .

- name: Install documenteer
run: pip install 'documenteer[pipelines]<0.7'

- name: Build documentation
working-directory: ./doc
run: package-docs build
call-workflow:
uses: lsst/rubin_workflows/.github/workflows/build_docs.yaml@main
6 changes: 6 additions & 0 deletions build_docs.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Ubuntu packages required for build_docs workflow
[ubuntu]
install = postgresql sqlite libyaml-dev
# pip install packages required for build_docs workflow
[pip]
install = psycopg2 testing postgresql

0 comments on commit 3a3e107

Please sign in to comment.