Skip to content

Commit

Permalink
Merge pull request #627 from pedro-psb/add-new-docs-ci
Browse files Browse the repository at this point in the history
Add unified docs-ci
  • Loading branch information
dkliban committed May 9, 2024
2 parents a85cc8f + 42028c6 commit 709efbb
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 1 deletion.
6 changes: 5 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,12 @@ jobs:
done
shell: bash

base-images:
docs:
needs: lint
uses: "./.github/workflows/docs-ci.yml"

base-images:
needs: docs
runs-on: ubuntu-latest
outputs:
image_variants: "${{ steps.image_variants.outputs.image_variants }}"
Expand Down
20 changes: 20 additions & 0 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: "Docs CI"

on:
workflow_call:

jobs:
test:
runs-on: "ubuntu-20.04"
steps:
- uses: "actions/checkout@v4"
- name: "Set up Python"
uses: "actions/setup-python@v5"
with:
python-version: "3.11"
- name: "Install Test Dependencies"
run: |
pip install -r doc_requirements.txt
- name: Build docs
run: make docs

10 changes: 10 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
help: ## Show this help.
@sed -ne '/@sed/!s/## //p' $(MAKEFILE_LIST)

docs: ## Build unified docs
pulp-docs build

servedocs: ## Serves unified docs
pulp-docs serve

.PHONY: docs servedocs help
1 change: 1 addition & 0 deletions doc_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pulp-docs @ git+https://github.com/pulp/pulp-docs@main

0 comments on commit 709efbb

Please sign in to comment.