This is an automated email from the ASF dual-hosted git repository. guoweijie pushed a commit to branch test-doc in repository https://gitbox.apache.org/repos/asf/flink.git
commit b57756788abf040828f13cc8db31538a36d18057 Author: Weijie Guo <[email protected]> AuthorDate: Fri Aug 2 11:53:07 2024 +0800 upload file --- .github/workflows/docs-new.sh | 82 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) diff --git a/.github/workflows/docs-new.sh b/.github/workflows/docs-new.sh new file mode 100755 index 00000000000..14a00a0fd0a --- /dev/null +++ b/.github/workflows/docs-new.sh @@ -0,0 +1,82 @@ +#!/usr/bin/env bash +################################################################################ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +################################################################################ +set -e +set -x +echo "new doc build" +mvn --version +java -version +javadoc -J-version + +# workaround for a git security patch +git config --global --add safe.directory /root/flink +git submodule update --init --recursive + +cd docs + +# setup hugo +source setup_hugo.sh + +# Setup the external documentation modules +source setup_docs.sh + +cd .. + +# Build the docs +hugo --source docs + +# generate docs into docs/target +hugo -v --source docs --destination target +if [ $? -ne 0 ]; then + echo "Error building the docs" + exit 1 +fi + +echo "build Flink; required for Javadoc step" +# build Flink; required for Javadoc step +mvn clean install -B -DskipTests -Dfast -Dskip.npm -Pskip-webui-build +echo "finish build Flink" + +# build java/scala docs +mkdir -p docs/target/api +mvn javadoc:aggregate -B \ + -DadditionalJOption="-Xdoclint:none --allow-script-in-comments" \ + -Dmaven.javadoc.failOnError=false \ + -Dcheckstyle.skip=true \ + -Dspotless.check.skip=true \ + -Denforcer.skip=true \ + -Dheader="<a href=\"http://flink.apache.org/\"; target=\"_top\"><h1>Back to Flink Website</h1></a> <script>var _paq=window._paq=window._paq||[];_paq.push([\"disableCookies\"]),_paq.push([\"setDomains\",[\"*.flink.apache.org\",\"*.nightlies.apache.org/flink\"]]),_paq.push([\"trackPageView\"]),_paq.push([\"enableLinkTracking\"]),function(){var u=\"//matomo.privacy.apache.org/\";_paq.push([\"setTrackerUrl\",u+\"matomo.php\"]),_paq.push([\"setSiteId\",\"1\"]);var d=document, g=d.createEle [...] +mv target/site/apidocs docs/target/api/java +mvn -pl flink-scala scala:doc -B \ + -Dcheckstyle.skip=true \ + -Dspotless.skip=true \ + -Denforcer.skip=true +mv flink-scala/target/site/scaladocs docs/target/api/scala + +# build python docs +if [ -f ./flink-python/dev/lint-python.sh ]; then + # Just completely ignore sudo in conda. + unset SUDO_UID SUDO_GID SUDO_USER + + # build python docs + # disable the gateway, because otherwise it tries to find FLINK_HOME to access Java classes + PYFLINK_GATEWAY_DISABLED=1 ./flink-python/dev/lint-python.sh -i "sphinx" + + # move python docs + mv flink-python/docs/_build/html docs/target/api/python +fi
