You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by mb...@apache.org on 2022/11/28 14:52:44 UTC
[flink-kubernetes-operator] branch main updated: [FLINK-27037] Add Javadocs publishing to docs generation
This is an automated email from the ASF dual-hosted git repository.
mbalassi pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 2d3b2a1e [FLINK-27037] Add Javadocs publishing to docs generation
2d3b2a1e is described below
commit 2d3b2a1e8d2c8b3df259345d9a2c4329bf77c59c
Author: Márton Balassi <ma...@apple.com>
AuthorDate: Mon Nov 28 15:52:39 2022 +0100
[FLINK-27037] Add Javadocs publishing to docs generation
---
.github/workflows/docs.sh | 20 +++++++++-------
docs/config.toml | 5 +++-
flink-kubernetes-operator-api/pom.xml | 45 ++++++++++++++++++++---------------
flink-kubernetes-operator/pom.xml | 24 -------------------
pom.xml | 25 +++++++++++++++++++
5 files changed, 66 insertions(+), 53 deletions(-)
diff --git a/.github/workflows/docs.sh b/.github/workflows/docs.sh
index 7c1f350a..a6eb9c8d 100755
--- a/.github/workflows/docs.sh
+++ b/.github/workflows/docs.sh
@@ -40,12 +40,14 @@ fi
#mvn clean install -B -DskipTests
# build Java 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.createEl [...]
-#mv target/site/apidocs docs/target/api/java
\ No newline at end of file
+mkdir -p docs/target/api
+mvn javadoc:aggregate -B \
+ -DadditionalJOption="-Xdoclint:none" \
+ -DadditionalJOption="--allow-script-in-comments" \
+ -DexcludePackageNames="org.apache.flink.examples"
+ -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
diff --git a/docs/config.toml b/docs/config.toml
index e6d00587..80c6c36f 100644
--- a/docs/config.toml
+++ b/docs/config.toml
@@ -53,10 +53,13 @@ pygmentsUseClasses = true
ProjectHomepage = "//flink.apache.org"
+ JavaDocs = "//nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/api/java/"
+
# External links at the bottom
# of the menu
MenuLinks = [
- ["Project Homepage", "//flink.apache.org"]
+ ["Project Homepage", "//flink.apache.org"],
+ ["JavaDocs", "//nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/api/java/"]
]
PreviousDocs = [
diff --git a/flink-kubernetes-operator-api/pom.xml b/flink-kubernetes-operator-api/pom.xml
index f0b5bbd8..907e2ce5 100644
--- a/flink-kubernetes-operator-api/pom.xml
+++ b/flink-kubernetes-operator-api/pom.xml
@@ -143,8 +143,33 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <version>3.3.2</version>
+ <version>${maven-javadoc-plugin.version}</version>
<executions>
+ <execution>
+ <id>doc-crd</id>
+ <phase>package</phase>
+ <goals>
+ <goal>javadoc</goal>
+ </goals>
+ <configuration>
+ <doclet>org.apache.flink.kubernetes.operator.api.docs.CrdReferenceDoclet</doclet>
+ <docletArtifacts>
+ <docletArtifact>
+ <groupId>org.apache.flink</groupId>
+ <artifactId>flink-kubernetes-operator-api</artifactId>
+ <version>${project.version}</version>
+ </docletArtifact>
+ </docletArtifacts>
+ <additionalOptions>
+ <additionalOption>--outputFile</additionalOption>
+ <additionalOption>${project.basedir}/../docs/content/docs/custom-resource/reference.md
+ </additionalOption>
+ <additionalOption>--templateFile</additionalOption>
+ <additionalOption>${project.basedir}/../docs/template/crd-ref.template</additionalOption>
+ </additionalOptions>
+ <useStandardDocletOptions>false</useStandardDocletOptions>
+ </configuration>
+ </execution>
<execution>
<id>doc</id>
<phase>package</phase>
@@ -153,24 +178,6 @@ under the License.
</goals>
</execution>
</executions>
- <configuration>
- <doclet>org.apache.flink.kubernetes.operator.api.docs.CrdReferenceDoclet</doclet>
- <docletArtifacts>
- <docletArtifact>
- <groupId>org.apache.flink</groupId>
- <artifactId>flink-kubernetes-operator-api</artifactId>
- <version>${project.version}</version>
- </docletArtifact>
- </docletArtifacts>
- <additionalOptions>
- <additionalOption>--outputFile</additionalOption>
- <additionalOption>${project.basedir}/../docs/content/docs/custom-resource/reference.md
- </additionalOption>
- <additionalOption>--templateFile</additionalOption>
- <additionalOption>${project.basedir}/../docs/template/crd-ref.template</additionalOption>
- </additionalOptions>
- <useStandardDocletOptions>false</useStandardDocletOptions>
- </configuration>
</plugin>
</plugins>
</build>
diff --git a/flink-kubernetes-operator/pom.xml b/flink-kubernetes-operator/pom.xml
index 08d5f14b..a45c9d81 100644
--- a/flink-kubernetes-operator/pom.xml
+++ b/flink-kubernetes-operator/pom.xml
@@ -341,30 +341,6 @@ under the License.
</plugins>
</build>
<profiles>
- <profile>
- <id>generate-docs</id>
- <activation>
- <activeByDefault>false</activeByDefault>
- </activation>
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>3.3.2</version>
- <executions>
- <execution>
- <id>doc</id>
- <phase>package</phase>
- <goals>
- <goal>javadoc</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
<profile>
<id>apache-release</id>
<build>
diff --git a/pom.xml b/pom.xml
index 328df12a..f4289052 100644
--- a/pom.xml
+++ b/pom.xml
@@ -67,6 +67,7 @@ under the License.
<maven-surefire-plugin.version>3.0.0-M4</maven-surefire-plugin.version>
<maven-failsafe-plugin.version>3.0.0-M5</maven-failsafe-plugin.version>
<maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
+ <maven-javadoc-plugin.version>3.3.2</maven-javadoc-plugin.version>
<git-commit-id-maven-plugin.version>5.0.0</git-commit-id-maven-plugin.version>
<operator.sdk.version>4.1.1</operator.sdk.version>
@@ -137,6 +138,30 @@ under the License.
</plugins>
</build>
</profile>
+ <profile>
+ <id>generate-docs</id>
+ <activation>
+ <activeByDefault>false</activeByDefault>
+ </activation>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${maven-javadoc-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>doc</id>
+ <phase>package</phase>
+ <goals>
+ <goal>javadoc</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
</profiles>
<build>