You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by mm...@apache.org on 2019/06/04 22:30:56 UTC
[pulsar] branch master updated: Use versioned path for reference
docs (#4420)
This is an automated email from the ASF dual-hosted git repository.
mmerli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new afc4de4 Use versioned path for reference docs (#4420)
afc4de4 is described below
commit afc4de4967eef265f49b47c2109c9b036f883741
Author: Matteo Merli <mm...@apache.org>
AuthorDate: Tue Jun 4 15:30:49 2019 -0700
Use versioned path for reference docs (#4420)
---
pulsar-client-cpp/Doxyfile | 2 +-
site2/tools/{doxygen-doc-gen.sh => build-site.sh} | 25 +++++++++++++----------
site2/tools/docker-build-site.sh | 2 +-
site2/tools/doxygen-doc-gen.sh | 5 ++---
site2/tools/generate-api-docs.sh | 10 +++++++++
site2/tools/javadoc-gen.sh | 7 ++++---
site2/tools/python-doc-gen.sh | 6 ++++--
7 files changed, 36 insertions(+), 21 deletions(-)
diff --git a/pulsar-client-cpp/Doxyfile b/pulsar-client-cpp/Doxyfile
index 3eb42e9..b3ac004 100644
--- a/pulsar-client-cpp/Doxyfile
+++ b/pulsar-client-cpp/Doxyfile
@@ -77,7 +77,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
-OUTPUT_DIRECTORY = ../generated-site/api/cpp
+OUTPUT_DIRECTORY = ../target/doxygen
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and
diff --git a/site2/tools/doxygen-doc-gen.sh b/site2/tools/build-site.sh
similarity index 69%
copy from site2/tools/doxygen-doc-gen.sh
copy to site2/tools/build-site.sh
index 3925db5..bf2826a 100755
--- a/site2/tools/doxygen-doc-gen.sh
+++ b/site2/tools/build-site.sh
@@ -18,18 +18,21 @@
# under the License.
#
-set -x -e
-
ROOT_DIR=$(git rev-parse --show-toplevel)
-DOXYGEN=doxygen
-TMP_DIR=$(mktemp -d)
+VERSION=`${ROOT_DIR}/src/get-project-version.py`
+
+set -x -e
-mkdir -p $ROOT_DIR/generated-site/api/cpp
+${ROOT_DIR}/site2/tools/generate-api-docs.sh
+cd ${ROOT_DIR}/site2/website
+yarn
+yarn write-translations
+yarn run crowdin-upload
+yarn run crowdin-download
+yarn build
-(
- cd $ROOT_DIR/pulsar-client-cpp
- $DOXYGEN Doxyfile
-)
+node ./scripts/replace.js
-mv $ROOT_DIR/generated-site/api/cpp $TMP_DIR
-mv $TMP_DIR/cpp/html $ROOT_DIR/generated-site/api/cpp
+rm -rf ${ROOT_DIR}/generated-site/content
+mkdir -p ${ROOT_DIR}/generated-site/content
+cp -R ./build/pulsar/* ${ROOT_DIR}/generated-site/content
diff --git a/site2/tools/docker-build-site.sh b/site2/tools/docker-build-site.sh
index 0991d3e..df0f113 100755
--- a/site2/tools/docker-build-site.sh
+++ b/site2/tools/docker-build-site.sh
@@ -44,4 +44,4 @@ CROWDIN_DOCUSAURUS_API_KEY=${CROWDIN_DOCUSAURUS_API_KEY:-UNSET}
DOCKER_CMD="docker run -i -e CI_USER=$CI_USER -e CI_GROUP=$CI_GROUP -e CROWDIN_DOCUSAURUS_PROJECT_ID=${CROWDIN_DOCUSAURUS_PROJECT_ID} -e CROWDIN_DOCUSAURUS_API_KEY=${CROWDIN_DOCUSAURUS_API_KEY} -v $ROOT_DIR:/pulsar $IMAGE"
-$DOCKER_CMD bash -l -c '/pulsar/site2/tools/generate-api-docs.sh && cd /pulsar/site2/website && yarn && yarn write-translations && yarn run crowdin-upload && yarn run crowdin-download && yarn build && node ./scripts/replace.js && rm -rf /pulsar/generated-site/content && mkdir -p /pulsar/generated-site/content && cp -R ./build/pulsar/* /pulsar/generated-site/content'
+$DOCKER_CMD bash -l -c 'cd /pulsar && /pulsar/site2/tools/build-site.sh'
diff --git a/site2/tools/doxygen-doc-gen.sh b/site2/tools/doxygen-doc-gen.sh
index 3925db5..23d4056 100755
--- a/site2/tools/doxygen-doc-gen.sh
+++ b/site2/tools/doxygen-doc-gen.sh
@@ -21,8 +21,8 @@
set -x -e
ROOT_DIR=$(git rev-parse --show-toplevel)
+VERSION=`${ROOT_DIR}/src/get-project-version.py`
DOXYGEN=doxygen
-TMP_DIR=$(mktemp -d)
mkdir -p $ROOT_DIR/generated-site/api/cpp
@@ -31,5 +31,4 @@ mkdir -p $ROOT_DIR/generated-site/api/cpp
$DOXYGEN Doxyfile
)
-mv $ROOT_DIR/generated-site/api/cpp $TMP_DIR
-mv $TMP_DIR/cpp/html $ROOT_DIR/generated-site/api/cpp
+mv $ROOT_DIR/target/doxygen/html $ROOT_DIR/generated-site/api/cpp/${VERSION}
diff --git a/site2/tools/generate-api-docs.sh b/site2/tools/generate-api-docs.sh
index 668dbbb..937d951 100755
--- a/site2/tools/generate-api-docs.sh
+++ b/site2/tools/generate-api-docs.sh
@@ -18,8 +18,18 @@
# under the License.
#
+SCRIPT_DIR=`dirname "$0"`
+cd $SCRIPT_DIR
+
+ROOT_DIR=$(git rev-parse --show-toplevel)
+VERSION=`${ROOT_DIR}/src/get-project-version.py`
+
set -x -e
+cd ${ROOT_DIR}
+mkdir -p site2/website/static/swagger/${VERSION}
+cp pulsar-broker/target/docs/*.json site2/website/static/swagger/${VERSION}/
+
SCRIPT_DIR=`dirname "$0"`
cd $SCRIPT_DIR
diff --git a/site2/tools/javadoc-gen.sh b/site2/tools/javadoc-gen.sh
index 5a9e8d1..d3351a8 100755
--- a/site2/tools/javadoc-gen.sh
+++ b/site2/tools/javadoc-gen.sh
@@ -20,6 +20,7 @@
ROOT_DIR=$(git rev-parse --show-toplevel)
+VERSION=`${ROOT_DIR}/src/get-project-version.py`
DEST_DIR=$ROOT_DIR/generated-site
JDK_COMMON_PKGS=java.lang:java.util:java.util.concurrent:java.nio:java.net:java.io
@@ -32,7 +33,7 @@ JDK_COMMON_PKGS=java.lang:java.util:java.util.concurrent:java.nio:java.net:java.
-windowtitle "Pulsar Client Java API" \
-doctitle "Pulsar Client Java API" \
-overview site/javadoc/client.html \
- -d $DEST_DIR/api/client \
+ -d $DEST_DIR/api/client/${VERSION}/ \
-subpackages org.apache.pulsar.client.api \
-noqualifier $JDK_COMMON_PKGS \
-notimestamp \
@@ -45,7 +46,7 @@ JDK_COMMON_PKGS=java.lang:java.util:java.util.concurrent:java.nio:java.net:java.
-windowtitle "Pulsar Admin Java API" \
-doctitle "Pulsar Admin Java API" \
-overview site/javadoc/admin.html \
- -d $DEST_DIR/api/admin \
+ -d $DEST_DIR/api/admin/${VERSION}/ \
-noqualifier $JDK_COMMON_PKGS \
-notimestamp \
-Xdoclint:none \
@@ -58,7 +59,7 @@ JDK_COMMON_PKGS=java.lang:java.util:java.util.concurrent:java.nio:java.net:java.
-windowtitle "Pulsar Functions Java SDK" \
-doctitle "Pulsar Functions Java SDK" \
-overview site/javadoc/pulsar-functions.html \
- -d $DEST_DIR/api/pulsar-functions \
+ -d $DEST_DIR/api/pulsar-functions/${VERSION}/ \
-noqualifier $JDK_COMMON_PKGS \
-notimestamp \
-Xdoclint:none \
diff --git a/site2/tools/python-doc-gen.sh b/site2/tools/python-doc-gen.sh
index 640cab8..91e6084 100755
--- a/site2/tools/python-doc-gen.sh
+++ b/site2/tools/python-doc-gen.sh
@@ -21,6 +21,7 @@
set -xe
ROOT_DIR=$(git rev-parse --show-toplevel)
+VERSION=`${ROOT_DIR}/src/get-project-version.py`
# Make sure the Python client lib is installed
# so that Pdoc can import the module
@@ -36,8 +37,9 @@ pip install six
pip install fastavro
pip install certifi
-DESTINATION=$ROOT_DIR/generated-site/api/python
-rm -fr $DESTINATION/{index.html,functions,pulsar}
+DESTINATION=$ROOT_DIR/generated-site/api/python/${VERSION}
+rm -fr $DESTINATION
+mkdir -p $DESTINATION
PYTHONPATH=$ROOT_DIR/pulsar-client-cpp/python pdoc pulsar \
--html \
--html-dir $DESTINATION