merlimat closed pull request #1830: Add Pulsar Functions API docs to site build
URL: https://github.com/apache/incubator-pulsar/pull/1830
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/site/.gitignore b/site/.gitignore
index 3ebc2241d3..dc815c9f12 100644
--- a/site/.gitignore
+++ b/site/.gitignore
@@ -3,10 +3,7 @@
.bundle/
node_modules/
vendor/
-api/admin/
-api/client/
-api/cpp
-api/python
+api/
generated/
.sass-cache
_data/config/*.bak
diff --git a/site/Makefile b/site/Makefile
index 3694bdf6de..eb30cfbeb1 100644
--- a/site/Makefile
+++ b/site/Makefile
@@ -72,6 +72,7 @@ serve: clean_local
--livereload \
--config _config.yml,_config.local.yml
+.PHONY: javadoc
javadoc:
rm -rf api/{admin,client}
scripts/javadoc-gen.sh
diff --git a/site/_includes/navbar.html b/site/_includes/navbar.html
index 6996224efc..4516069803 100644
--- a/site/_includes/navbar.html
+++ b/site/_includes/navbar.html
@@ -80,6 +80,9 @@ <h3 class="dropdown-header">Other releases</h3>
<a class="dropdown-item" href="/api/admin">
Java admin Javadoc
</a>
+ <a class="dropdown-item" href="/api/pulsar-functions">
+ Pulsar Functions Java SDK
+ </a>
<a class="dropdown-item" href="/api/python">
Python API docs
</a>
diff --git a/site/scripts/javadoc-admin.html b/site/javadoc/admin.html
similarity index 100%
rename from site/scripts/javadoc-admin.html
rename to site/javadoc/admin.html
diff --git a/site/scripts/javadoc-client.html b/site/javadoc/client.html
similarity index 100%
rename from site/scripts/javadoc-client.html
rename to site/javadoc/client.html
diff --git a/site/javadoc/pulsar-functions.html
b/site/javadoc/pulsar-functions.html
new file mode 100644
index 0000000000..02c1139821
--- /dev/null
+++ b/site/javadoc/pulsar-functions.html
@@ -0,0 +1,26 @@
+<!--
+
+ 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.
+
+-->
+<body>
+ <p>
+ Javadoc for all classes and interfaces associated with the <a
href="http://pulsar.incubator.apache.org/docs/latest/functions/api/#java";>Java
SDK</a> for <a
href="http://pulsar.incubator.apache.org/docs/latest/functions/overview/";>Pulsar
Functions</a>.
+ </p>
+</body>
+
\ No newline at end of file
diff --git a/site/scripts/javadoc-gen.sh b/site/scripts/javadoc-gen.sh
index be174253ee..851088cded 100755
--- a/site/scripts/javadoc-gen.sh
+++ b/site/scripts/javadoc-gen.sh
@@ -30,7 +30,7 @@
JDK_COMMON_PKGS=java.lang:java.util:java.util.concurrent:java.nio:java.net:java.
-quiet \
-windowtitle "Pulsar Client Java API" \
-doctitle "Pulsar Client Java API" \
- -overview site/scripts/javadoc-client.html \
+ -overview site/javadoc/client.html \
-d site/api/client \
-subpackages org.apache.pulsar.client.api \
-noqualifier $JDK_COMMON_PKGS \
@@ -43,7 +43,7 @@
JDK_COMMON_PKGS=java.lang:java.util:java.util.concurrent:java.nio:java.net:java.
-quiet \
-windowtitle "Pulsar Admin Java API" \
-doctitle "Pulsar Admin Java API" \
- -overview site/scripts/javadoc-admin.html \
+ -overview site/javadoc/admin.html \
-d site/api/admin \
-noqualifier $JDK_COMMON_PKGS \
-notimestamp \
@@ -51,6 +51,19 @@
JDK_COMMON_PKGS=java.lang:java.util:java.util.concurrent:java.nio:java.net:java.
`find pulsar-client-admin -name *.java | grep -v /internal/` \
`find pulsar-common/src/main/java/org/apache/pulsar/common/policies -name
*.java`
+ # Pulsar Functions Java SDK
+ javadoc \
+ -quiet \
+ -windowtitle "Pulsar Functions Java SDK" \
+ -doctitle "Pulsar Functions Java SDK" \
+ -overview site/javadoc/pulsar-functions.html \
+ -d site/api/pulsar-functions \
+ -noqualifier $JDK_COMMON_PKGS \
+ -notimestamp \
+ -Xdoclint:none \
+ -exclude lombok.extern.slf4j.Slf4j \
+ `find
pulsar-functions/api-java/src/main/java/org/apache/pulsar/functions/api -name
*.java`
+
# Broker
#javadoc \
# -quiet \
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
