diff --git a/docs/docs/embedding.md b/docs/docs/embedding.md index e47be58d0..38b1705b5 100644 --- 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:
+[https://maxwells-daemon.io/apidocs](https://maxwells-daemon.io/apidocs) # Compatibility caveat *** diff --git a/docs/push b/docs/push index a14cf02cc..6723462e6 100755 --- 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 index 66009f414..e3d348cd3 100644 --- a/pom.xml +++ b/pom.xml @@ -428,6 +428,7 @@ maven-javadoc-plugin 3.3.1 + --no-module-directories 11