link to API docs

zendesk · Feb 11, 2022 · 76efa3c · lukestephenson-zendesk · Mar 7, 2022 · 76efa3c
1 parent f6c5e12
commit 76efa3c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 4 deletions.
diff --git a/docs/docs/embedding.md b/docs/docs/embedding.md
@@ -1,9 +1,10 @@
 # Embedding Maxwell
 ***
-Maxwell typically runs as a command-line program. However, for advanced use it
-is possible to run maxwell from any JVM-based language. Currently the source of
-truth is the source code (there is no published API documentation). Pull requests
-to better document embedded Maxwell uses are welcome.
+Maxwell typically runs as a command-line program. However, for advanced uses it
+is possible to run maxwell from any JVM-based language.
+
+Some fairly incomplete API documentation is available here:<br/>
+[https://maxwells-daemon.io/apidocs](https://maxwells-daemon.io/apidocs)
 
 # Compatibility caveat
 ***

diff --git a/docs/push b/docs/push
@@ -1,7 +1,10 @@
 #!/bin/bash
 
 set -eux
+make docs
+
 cd $(dirname $0)
 ./build
+cp -a ../target/site/apidocs site/
 (cd site && git add . && git commit -m 'update docs' && git push origin HEAD:gh-pages)
 ./clean
diff --git a/pom.xml b/pom.xml
@@ -428,6 +428,7 @@
         <artifactId>maven-javadoc-plugin</artifactId>
         <version>3.3.1</version>
         <configuration>
+            <additionalOptions>--no-module-directories</additionalOptions>
             <source>11</source>
         </configuration>
         <executions>