Browse Source

Publish to publish-docs/html

Publish to publish-docs/html to simplify our doc building and publishing
CI jobs.

Change-Id: I8beb68195a7beaa3f2c125ef83db0fa589837639
tags/2.0.0
Andreas Jaeger 1 month ago
parent
commit
a031fd772e

+ 4
- 4
bin/doc-tools-build-rst View File

@@ -18,7 +18,7 @@ if [ -z "$DIRECTORY" ] ; then
18 18
     echo "usage $0 DIRECTORY options"
19 19
     echo "Options are:"
20 20
     echo "--tag TAG: Use given tag for building"
21
-    echo "--target TARGET: Copy files to publish-docs/$TARGET"
21
+    echo "--target TARGET: Copy files to publish-docs/html/$TARGET"
22 22
     echo "--build BUILD: Name of build directory"
23 23
     echo "--linkcheck: Check validity of links instead of building"
24 24
     echo "--pdf: PDF file generation"
@@ -105,9 +105,9 @@ else
105 105
 
106 106
     # Copy RST (and PDF)
107 107
     if [ "$TARGET" != "" ] ; then
108
-        mkdir -p publish-docs/$TARGET
109
-        rsync -a $BUILD_DIR/ publish-docs/$TARGET/
108
+        mkdir -p publish-docs/html/$TARGET
109
+        rsync -a $BUILD_DIR/ publish-docs/html/$TARGET/
110 110
         # Remove unneeded build artefact
111
-        rm -f publish-docs/$TARGET/.buildinfo
111
+        rm -f publish-docs/html/$TARGET/.buildinfo
112 112
     fi
113 113
 fi

+ 2
- 2
bin/doc-tools-check-languages View File

@@ -96,7 +96,7 @@ function build_rst {
96 96
                 -d ${DOCTREES} \
97 97
                 ${DOC_DIR}${book}/source/ \
98 98
                 ${BUILD_DIR}
99
-            PUBLISH_DIR=publish-docs/${language}/${book}-${tag}
99
+            PUBLISH_DIR=publish-docs/html/${language}/${book}-${tag}
100 100
             mkdir -p ${PUBLISH_DIR}
101 101
             rsync -a ${DOC_DIR}${book}/build-${tag}/html/ ${PUBLISH_DIR}
102 102
             echo $MARKER_TEXT > ${PUBLISH_DIR}/.root-marker
@@ -109,7 +109,7 @@ function build_rst {
109 109
             -d ${DOCTREES} \
110 110
             ${DOC_DIR}${book}/source/ \
111 111
             ${BUILD_DIR}
112
-        PUBLISH_DIR=publish-docs/${language}/${book}/
112
+        PUBLISH_DIR=publish-docs/html/${language}/${book}/
113 113
         mkdir -p ${PUBLISH_DIR}
114 114
         rsync -a ${DOC_DIR}${book}/build/html/ ${PUBLISH_DIR}
115 115
         echo $MARKER_TEXT > ${PUBLISH_DIR}/.root-marker

+ 1
- 1
doc/source/man/openstack-doc-test.rst View File

@@ -83,7 +83,7 @@ OPTIONS
83 83
     check-build.
84 84
 
85 85
 **--publish**
86
-    Setup content in publish-docs directory for publishing to
86
+    Setup content in publish-docs/html directory for publishing to
87 87
     external website.
88 88
 
89 89
 **--verbose**

+ 4
- 0
releasenotes/notes/publish-docs-54aa1604f102cb7c.yaml View File

@@ -0,0 +1,4 @@
1
+critical:
2
+  - |
3
+    Change publishing from `publish-docs` to `publish-docs/html`. This needs
4
+    changing in build and publish CI jobs.

Loading…
Cancel
Save