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 reusable workflow for build_docs #691

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
51 changes: 6 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,8 @@ 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@tickets/DM-35133
with:
ubuntu_deps: "postgresql sqlite libyaml-dev"
pip_deps: "psycopg2 testing.postgresql"