Add new-docs CI and legacy docs banner

.github/template_gitref

@@ -1 +1 @@
-2021.08.26-326-ge5addc7
+2021.08.26-327-g520b576

.github/workflows/scripts/script.sh

@@ -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
@@ -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

.github/workflows/test.yml

@@ -23,6 +23,7 @@ jobs:
         env:
           - TEST: pulp
           - TEST: docs
+          - TEST: new_docs
           - TEST: azure
           - TEST: s3
           - TEST: lowerbounds

CHANGES/+docs-ci.misc

@@ -0,0 +1 @@
+Added the Unified Docs CI build-check on PRs.

doc_requirements.txt

@@ -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

docs/_static/css/custom.css

@@ -0,0 +1,43 @@
+.banner {
+  background: #ffe2c9;
+  height: 50px;
+  border-top: 5px solid #ffad67;
+  width: 100%;
+  position: fixed;
+  z-index: 9999;
+  box-shadow: 0 3px 10px -5px rgb(0 0 0 / 0.2);
+ }
+
+.banner__content {
+  padding: 16px;
+  max-width: 1120px;
+  margin: 0;
+  display: flex;
+  align-items: center;
+  height: 100%;
+ }
+
+.banner__text {
+  flex-grow: 1;
+  line_height: 1.4em;
+  text-align: center;
+  font-weight: bold;
+  font-family: Roboto Slab,ff-tisa-web-pro,Georgia,Arial,sans-serif;
+  color: #505050;
+}
+
+
+@media (min-width: 768px){
+  .wy-side-nav-search {
+    padding-top: 60px;
+  }
+}
+
+@media (max-width: 768px){
+  .wy-nav-top {
+    margin-top: 50px;
+  }
+  .wy-side-nav-search {
+    margin-top: 50px;
+  }
+}

docs/_templates/layout.html

@@ -0,0 +1,22 @@
+{#
+    classic/layout.html
+    ~~~~~~~~~~~~~~~~~~~
+
+    Sphinx layout template for the classic theme.
+
+    :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+#}
+{%- extends "sphinx_rtd_theme/layout.html" %}
+
+{%- block extrabody %}
+    <div class="banner">
+    <div class="banner__content">
+    <div class="banner__text">
+    This docs will be deactivated in July 2024.
+    <a href="https://discourse.pulpproject.org/t/unified-documentation-part-2/1188" target="blank">Learn More</a>
+    or go to the <a href="https://staging-docs.pulpproject.org/" target="blank">New Pulp Docs</a> (beta).
+    </div>
+    </div>
+    </div>
+{%- endblock %}

docs/conf.py

@@ -133,6 +133,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+html_css_files = ['css/custom.css']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

docs/template_gitref

@@ -0,0 +1 @@
+2021.08.26-327-g520b576

template_config.yml

@@ -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