Skip to content

Commit

Permalink
Turn docs-ci on
Browse files Browse the repository at this point in the history
Related to: pulp/pulp-docs#31

[noissue]
  • Loading branch information
pedro-psb committed Apr 16, 2024
1 parent 6f843ba commit 546af83
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/template_gitref
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2021.08.26-326-ge5addc7
2021.08.26-327-g520b576
8 changes: 8 additions & 0 deletions .github/workflows/scripts/script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ if [[ "$TEST" = "docs" ]]; then
if [[ "$GITHUB_WORKFLOW" == "Rpm CI" ]]; then
towncrier build --yes --version 4.0.0.ci
fi
# Unified Docs Build
pulp-docs build
# Legacy Docs Build
cd docs
make PULP_URL="$PULP_URL" diagrams html
Expand All @@ -43,6 +45,12 @@ if [[ "$TEST" = "docs" ]]; then
exit
fi

if [[ "$TEST" = "new_docs" ]]; then
pip install --user git+https://github.com/pulp/pulp-docs
pulp-docs build
exit
fi

REPORTED_STATUS="$(pulp status)"

echo "machine pulp
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
env:
- TEST: pulp
- TEST: docs
- TEST: new_docs
- TEST: azure
- TEST: s3
- TEST: lowerbounds
Expand Down
1 change: 1 addition & 0 deletions CHANGES/+docs-ci.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Added the Unified Docs CI build-check on PRs.
21 changes: 18 additions & 3 deletions doc_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,21 @@
# WARNING: DO NOT EDIT!
#
# This file was generated by plugin_template, and is managed by it. Please use
# './plugin-template --docs pulp_rpm' to update this file.
#
# For more info visit https://github.com/pulp/plugin_template
-r requirements.txt
towncrier

# Legacy docs
plantuml
sphinx<7.0
sphinx-rtd-theme==1.2.0
sphinx~=7.1.2
sphinx-rtd-theme==1.3.0
sphinxcontrib-jquery
sphinxcontrib-openapi
towncrier
mistune<4.0.0
Jinja2<3.2

# Unified docs
pulp-docs @ git+https://github.com/pulp/pulp-docs@main
# Extra requirements
Empty file added docs/static/.gitkeep
Empty file.
1 change: 1 addition & 0 deletions docs/template_gitref
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2021.08.26-327-g520b576
2 changes: 1 addition & 1 deletion template_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -89,5 +89,5 @@ test_reroute: true
test_s3: true
use_issue_template: true
use_legacy_docs: true
use_unified_docs: false
use_unified_docs: true

0 comments on commit 546af83

Please sign in to comment.