Skip to content

Commit 2d3b2a1

Browse files
mbalassimbalassi
authored
[FLINK-27037] Add Javadocs publishing to docs generation
1 parent b848382 commit 2d3b2a1

File tree

5 files changed

+66
-53
lines changed

5 files changed

+66
-53
lines changed

‎.github/workflows/docs.sh

+11-9
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,14 @@ fi
4040
#mvn clean install -B -DskipTests
4141

4242
# build Java docs
43-
#mkdir -p docs/target/api
44-
#mvn javadoc:aggregate -B \
45-
# -DadditionalJOption="-Xdoclint:none --allow-script-in-comments" \
46-
# -Dmaven.javadoc.failOnError=false \
47-
# -Dcheckstyle.skip=true \
48-
# -Dspotless.check.skip=true \
49-
# -Denforcer.skip=true \
50-
# -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.createElement('script'), s=d.getElementsByTagName('script')[0];g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s)}();</script>"
51-
#mv target/site/apidocs docs/target/api/java
43+
mkdir -p docs/target/api
44+
mvn javadoc:aggregate -B \
45+
-DadditionalJOption="-Xdoclint:none" \
46+
-DadditionalJOption="--allow-script-in-comments" \
47+
-DexcludePackageNames="org.apache.flink.examples"
48+
-Dmaven.javadoc.failOnError=false \
49+
-Dcheckstyle.skip=true \
50+
-Dspotless.check.skip=true \
51+
-Denforcer.skip=true \
52+
-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.createElement('script'), s=d.getElementsByTagName('script')[0];g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s)}();</script>"
53+
mv target/site/apidocs docs/target/api/java

‎docs/config.toml

+4-1
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,13 @@ pygmentsUseClasses = true
5353

5454
ProjectHomepage = "//flink.apache.org"
5555

56+
JavaDocs = "//nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/api/java/"
57+
5658
# External links at the bottom
5759
# of the menu
5860
MenuLinks = [
59-
["Project Homepage", "//flink.apache.org"]
61+
["Project Homepage", "//flink.apache.org"],
62+
["JavaDocs", "//nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/api/java/"]
6063
]
6164

6265
PreviousDocs = [

‎flink-kubernetes-operator-api/pom.xml

+26-19
Original file line numberDiff line numberDiff line change
@@ -143,8 +143,33 @@ under the License.
143143
<plugin>
144144
<groupId>org.apache.maven.plugins</groupId>
145145
<artifactId>maven-javadoc-plugin</artifactId>
146-
<version>3.3.2</version>
146+
<version>${maven-javadoc-plugin.version}</version>
147147
<executions>
148+
<execution>
149+
<id>doc-crd</id>
150+
<phase>package</phase>
151+
<goals>
152+
<goal>javadoc</goal>
153+
</goals>
154+
<configuration>
155+
<doclet>org.apache.flink.kubernetes.operator.api.docs.CrdReferenceDoclet</doclet>
156+
<docletArtifacts>
157+
<docletArtifact>
158+
<groupId>org.apache.flink</groupId>
159+
<artifactId>flink-kubernetes-operator-api</artifactId>
160+
<version>${project.version}</version>
161+
</docletArtifact>
162+
</docletArtifacts>
163+
<additionalOptions>
164+
<additionalOption>--outputFile</additionalOption>
165+
<additionalOption>${project.basedir}/../docs/content/docs/custom-resource/reference.md
166+
</additionalOption>
167+
<additionalOption>--templateFile</additionalOption>
168+
<additionalOption>${project.basedir}/../docs/template/crd-ref.template</additionalOption>
169+
</additionalOptions>
170+
<useStandardDocletOptions>false</useStandardDocletOptions>
171+
</configuration>
172+
</execution>
148173
<execution>
149174
<id>doc</id>
150175
<phase>package</phase>
@@ -153,24 +178,6 @@ under the License.
153178
</goals>
154179
</execution>
155180
</executions>
156-
<configuration>
157-
<doclet>org.apache.flink.kubernetes.operator.api.docs.CrdReferenceDoclet</doclet>
158-
<docletArtifacts>
159-
<docletArtifact>
160-
<groupId>org.apache.flink</groupId>
161-
<artifactId>flink-kubernetes-operator-api</artifactId>
162-
<version>${project.version}</version>
163-
</docletArtifact>
164-
</docletArtifacts>
165-
<additionalOptions>
166-
<additionalOption>--outputFile</additionalOption>
167-
<additionalOption>${project.basedir}/../docs/content/docs/custom-resource/reference.md
168-
</additionalOption>
169-
<additionalOption>--templateFile</additionalOption>
170-
<additionalOption>${project.basedir}/../docs/template/crd-ref.template</additionalOption>
171-
</additionalOptions>
172-
<useStandardDocletOptions>false</useStandardDocletOptions>
173-
</configuration>
174181
</plugin>
175182
</plugins>
176183
</build>

‎flink-kubernetes-operator/pom.xml

-24
Original file line numberDiff line numberDiff line change
@@ -341,30 +341,6 @@ under the License.
341341
</plugins>
342342
</build>
343343
<profiles>
344-
<profile>
345-
<id>generate-docs</id>
346-
<activation>
347-
<activeByDefault>false</activeByDefault>
348-
</activation>
349-
<build>
350-
<plugins>
351-
<plugin>
352-
<groupId>org.apache.maven.plugins</groupId>
353-
<artifactId>maven-javadoc-plugin</artifactId>
354-
<version>3.3.2</version>
355-
<executions>
356-
<execution>
357-
<id>doc</id>
358-
<phase>package</phase>
359-
<goals>
360-
<goal>javadoc</goal>
361-
</goals>
362-
</execution>
363-
</executions>
364-
</plugin>
365-
</plugins>
366-
</build>
367-
</profile>
368344
<profile>
369345
<id>apache-release</id>
370346
<build>

‎pom.xml

+25
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ under the License.
6767
<maven-surefire-plugin.version>3.0.0-M4</maven-surefire-plugin.version>
6868
<maven-failsafe-plugin.version>3.0.0-M5</maven-failsafe-plugin.version>
6969
<maven-resources-plugin.version>3.2.0</maven-resources-plugin.version>
70+
<maven-javadoc-plugin.version>3.3.2</maven-javadoc-plugin.version>
7071
<git-commit-id-maven-plugin.version>5.0.0</git-commit-id-maven-plugin.version>
7172

7273
<operator.sdk.version>4.1.1</operator.sdk.version>
@@ -137,6 +138,30 @@ under the License.
137138
</plugins>
138139
</build>
139140
</profile>
141+
<profile>
142+
<id>generate-docs</id>
143+
<activation>
144+
<activeByDefault>false</activeByDefault>
145+
</activation>
146+
<build>
147+
<plugins>
148+
<plugin>
149+
<groupId>org.apache.maven.plugins</groupId>
150+
<artifactId>maven-javadoc-plugin</artifactId>
151+
<version>${maven-javadoc-plugin.version}</version>
152+
<executions>
153+
<execution>
154+
<id>doc</id>
155+
<phase>package</phase>
156+
<goals>
157+
<goal>javadoc</goal>
158+
</goals>
159+
</execution>
160+
</executions>
161+
</plugin>
162+
</plugins>
163+
</build>
164+
</profile>
140165
</profiles>
141166

142167
<build>

0 commit comments

Comments
 (0)