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 2018/05/22 18:36:33 UTC
[incubator-pulsar] branch master updated: Add Pulsar Functions API
docs to site build (#1830)
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/incubator-pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 6ea9d85 Add Pulsar Functions API docs to site build (#1830)
6ea9d85 is described below
commit 6ea9d8501027b63c2e097e0b82d579fc02dae509
Author: Luc Perkins <lu...@gmail.com>
AuthorDate: Tue May 22 11:36:31 2018 -0700
Add Pulsar Functions API docs to site build (#1830)
* add javadoc templates to separate folder and add PF API doc gen to script
* add links to PF SDK docs in navbar
---
site/.gitignore | 5 +----
site/Makefile | 1 +
site/_includes/navbar.html | 3 +++
.../{scripts/javadoc-client.html => javadoc/admin.html} | 0
.../{scripts/javadoc-admin.html => javadoc/client.html} | 0
.../pulsar-functions.html} | 3 ++-
site/scripts/javadoc-gen.sh | 17 +++++++++++++++--
7 files changed, 22 insertions(+), 7 deletions(-)
diff --git a/site/.gitignore b/site/.gitignore
index 3ebc224..dc815c9 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 3694bdf..eb30cfb 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 6996224..4516069 100644
--- a/site/_includes/navbar.html
+++ b/site/_includes/navbar.html
@@ -80,6 +80,9 @@
<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-client.html b/site/javadoc/admin.html
similarity index 100%
copy from site/scripts/javadoc-client.html
copy to site/javadoc/admin.html
diff --git a/site/scripts/javadoc-admin.html b/site/javadoc/client.html
similarity index 100%
rename from site/scripts/javadoc-admin.html
rename to site/javadoc/client.html
diff --git a/site/scripts/javadoc-client.html b/site/javadoc/pulsar-functions.html
similarity index 76%
rename from site/scripts/javadoc-client.html
rename to site/javadoc/pulsar-functions.html
index f46cdfc..02c1139 100644
--- a/site/scripts/javadoc-client.html
+++ b/site/javadoc/pulsar-functions.html
@@ -20,6 +20,7 @@
-->
<body>
<p>
- Javadoc for all classes and interfaces associated with the Java client for <a href="https://pulsar.incubator.apache.org/">Pulsar</a>.
+ 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 be17425..851088c 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 \
--
To stop receiving notification emails like this one, please contact
mmerli@apache.org.