Skip to content

Commit a98d8bd

Browse files
committed
Add unified docs-ci
Related to: pulp/pulp-docs#31 [noissue]
1 parent 75ee4c1 commit a98d8bd

File tree

4 files changed

+33
-0
lines changed

4 files changed

+33
-0
lines changed

.github/workflows/ci.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ on:
99
- '**'
1010
workflow_dispatch:
1111
jobs:
12+
docs:
13+
uses: "./.github/workflows/docs-ci.yml"
14+
1215
integration:
1316
strategy:
1417
fail-fast: false

.github/workflows/docs-ci.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: "Docs CI"
2+
3+
on:
4+
workflow_call:
5+
6+
jobs:
7+
test:
8+
runs-on: "ubuntu-20.04"
9+
steps:
10+
- uses: "actions/checkout@v4"
11+
- name: "Set up Python"
12+
uses: "actions/setup-python@v5"
13+
with:
14+
python-version: "3.11"
15+
- name: "Install Test Dependencies"
16+
run: |
17+
pip install -r doc_requirements.txt
18+
- name: Build docs
19+
run: make docs

Makefile

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
help: ## Show this help.
2+
@sed -ne '/@sed/!s/## //p' $(MAKEFILE_LIST)
3+
4+
docs: ## Build unified docs.
5+
pulp-docs build
6+
7+
servedocs: ## Serves unified docs.
8+
pulp-docs serve
9+
10+
.PHONY: docs servedocs help

doc_requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pulp-docs @ git+https://github.com/pulp/pulp-docs@main

0 commit comments

Comments
 (0)