From a98d8bd50e2261627d4c97a628f988e4cde7ed0c Mon Sep 17 00:00:00 2001 From: Pedro Brochado Date: Tue, 16 Apr 2024 17:07:53 -0300 Subject: [PATCH] Add unified docs-ci Related to: https://github.com/pulp/pulp-docs/issues/31 [noissue] --- .github/workflows/ci.yaml | 3 +++ .github/workflows/docs-ci.yml | 19 +++++++++++++++++++ Makefile | 10 ++++++++++ doc_requirements.txt | 1 + 4 files changed, 33 insertions(+) create mode 100644 .github/workflows/docs-ci.yml create mode 100644 Makefile create mode 100644 doc_requirements.txt diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 5f1dc1e..30a9ecb 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -9,6 +9,9 @@ on: - '**' workflow_dispatch: jobs: + docs: + uses: "./.github/workflows/docs-ci.yml" + integration: strategy: fail-fast: false diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml new file mode 100644 index 0000000..ccd6215 --- /dev/null +++ b/.github/workflows/docs-ci.yml @@ -0,0 +1,19 @@ +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 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..26161df --- /dev/null +++ b/Makefile @@ -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 diff --git a/doc_requirements.txt b/doc_requirements.txt new file mode 100644 index 0000000..60e329d --- /dev/null +++ b/doc_requirements.txt @@ -0,0 +1 @@ +pulp-docs @ git+https://github.com/pulp/pulp-docs@main