diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..bef26c7c9 --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +# Makefile for the Embedded Neo4j Python bindings documentation. +# + +# Project Configuration +project_name = manual +language = en + +# Minimal setup +target = target +build_dir = $(CURDIR)/$(target) +config_dir = $(CURDIR)/docs/conf +tools_dir = $(build_dir)/tools +make_dir = $(tools_dir)/make + +include $(make_dir)/context-manual.make + diff --git a/README.md b/README.md index 01f2c403f..fffa683a6 100755 --- a/README.md +++ b/README.md @@ -4,7 +4,9 @@ Neo4j Spatial is a library facilitating the import, storage and querying of spatial data in the [Neo4j open source graph database](http://neo4j.org/). -![Open Street Map](https://raw.github.com/neo4j/spatial/master/src/docs/dev/images/one-street.png "Open Street Map") +This projects manual is deployed as part of the local build as the [Neo4j Spatial Manual](http://neo4j.github.io/spatial) + +![Open Street Map](https://raw.github.com/neo4j/spatial/master/src/docs/images/one-street.png "Open Street Map") Some key features include: @@ -117,6 +119,29 @@ Tested with: GeoServer 2.1.1 mvn clean install ~~~ + +### Building and deploying the docs### + +Add your Github credentials in your `~/.m2/settings.xml` + +~~~xml + + + + github + xxx@xxx.xx + secret + + + +~~~ + +now do + +~~~bash + mvn clean install site -Pneo-docs-build - +~~~ + ### Deployment into Geoserver ### * unzip the `target/xxxx-server-plugin.zip` and the Neo4j libraries from your Neo4j download under `$NEO4J_HOME/lib` into `$GEOSERVER_HOME/webapps/geoserver/WEB-INF/lib` diff --git a/pom.xml b/pom.xml index 2b4407d26..ff76e4cde 100644 --- a/pom.xml +++ b/pom.xml @@ -3,6 +3,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 1.9.RC2 + 1.6 0.5 8.4 20100819 @@ -11,6 +12,7 @@ 1.2 1.5 UTF-8 + github @@ -41,6 +43,29 @@ true + + org.apache.maven.plugins + maven-resources-plugin + + + copy-resources + + package + + copy-resources + + + ${basedir}/target/filtered-test-sources + + + ${basedir}/target/filtered-test-sources + true + + + + + + maven-dependency-plugin @@ -94,35 +119,6 @@ - - - - - org.eclipse.m2e - lifecycle-mapping - 1.0.0 - - - - - - org.apache.maven.plugins - maven-dependency-plugin - [2.1,) - - copy-dependencies - - - - - - - - - - - - @@ -430,19 +426,198 @@ true - + + neo-docs-build + + false + + docsBuild + + + + + org.neo4j.build.plugins + neo4j-doctools + 13-SNAPSHOT + provided + + + + + + maven-dependency-plugin + + + unpack-doctools + generate-sources + + unpack-dependencies + + + jar + neo4j-doctools + ${docs.tools} + + + + + + maven-resources-plugin + + + copy-docs + process-resources + + copy-resources + + + ${project.build.directory}/src + + + src/docs + + + + + + copy-test-sources + process-resources + + copy-resources + + + + ${project.build.directory}/test-sources/${project.artifactId}-test-sources-jar + + + + src/test/java + + + + + + copy-configuration + process-resources + + copy-resources + + + ${project.build.directory}/conf + + + src/docs/conf + + + + + + + filter-asciidoc-files + post-integration-test + + copy-resources + + + ${project.build.directory}/docs-filtered + + + ${project.build.directory}/docs + true + + + + + + + copy-filtered-asciidoc-files-back + post-integration-test + + copy-resources + + + ${project.build.directory}/docs + + + ${project.build.directory}/docs-filtered + false + + + + + + + copy-generated-files + post-integration-test + + copy-resources + + + ${project.build.directory}/src/dev + + + ${project.build.directory}/docs + + + + + + + + org.codehaus.mojo + exec-maven-plugin + + + execute-asciidoc + verify + + exec + + + make + + init + preview + VERSION=${project.version} + + + + + + + + org.apache.maven.plugins + maven-site-plugin + + true + + + + com.github.github + site-maven-plugin + 0.8-SNAPSHOT + + Creating site for ${project.version} + target/html5 + + + + + site + + site + + + + + + + ${project.build.directory}/tools + none + + test-default diff --git a/src/docs/conf/asciidoc.local.conf b/src/docs/conf/asciidoc.local.conf new file mode 100644 index 000000000..bc9f1493d --- /dev/null +++ b/src/docs/conf/asciidoc.local.conf @@ -0,0 +1,5 @@ +[attributes] +imagesdir=images +iconsdir=images/icons +imagestargetdir=target/src/images +fontsdir=target/tools/bin/fonts \ No newline at end of file diff --git a/src/docs/conf/version b/src/docs/conf/version new file mode 100644 index 000000000..ad96e7cf9 --- /dev/null +++ b/src/docs/conf/version @@ -0,0 +1 @@ +${project.version} diff --git a/src/docs/dev/examples.txt b/src/docs/dev/examples.txt index 9b137acce..cb9d5d1a9 100644 --- a/src/docs/dev/examples.txt +++ b/src/docs/dev/examples.txt @@ -120,39 +120,39 @@ the different steps. :leveloffset: 3 -include::examples/search-within-geometry.txt[] +include::examples/search-within-geometry.asciidoc[] -include::examples/intersecting-windows.txt[] +include::examples/intersecting-windows.asciidoc[] -include::examples/intersect-all.txt[] -include::examples/unite-all.txt[] +include::examples/intersect-all.asciidoc[] +include::examples/unite-all.asciidoc[] -include::examples/extract-points.txt[] +include::examples/extract-points.asciidoc[] -include::examples/filter-by-cql-using-complex-cql.txt[] +include::examples/filter-by-cql-using-complex-cql.asciidoc[] -include::examples/boundary.txt[] +include::examples/boundary.asciidoc[] -include::examples/centroid.txt[] +include::examples/centroid.asciidoc[] -include::examples/convex-hull.txt[] +include::examples/convex-hull.asciidoc[] -include::examples/densify.txt[] +include::examples/densify.asciidoc[] -include::examples/envelope.txt[] +include::examples/envelope.asciidoc[] -include::examples/export-to-gml.txt[] +include::examples/export-to-gml.asciidoc[] -include::examples/intersection.txt[] +include::examples/intersection.asciidoc[] -include::examples/union.txt[] +include::examples/union.asciidoc[] -include::examples/start-point.txt[] -include::examples/end-point.txt[] +include::examples/start-point.asciidoc[] +include::examples/end-point.asciidoc[] -include::examples/max.txt[] -include::examples/min.txt[] +include::examples/max.asciidoc[] +include::examples/min.asciidoc[] -include::examples/break-up-all-geometries-into-points-and-make-density-islands.txt[] +include::examples/break-up-all-geometries-into-points-and-make-density-islands.asciidoc[] diff --git a/src/docs/docinfo.html b/src/docs/docinfo.html new file mode 100644 index 000000000..cebb7f193 --- /dev/null +++ b/src/docs/docinfo.html @@ -0,0 +1,65 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/docs/dev/images/one-street.png b/src/docs/images/one-street.png similarity index 100% rename from src/docs/dev/images/one-street.png rename to src/docs/images/one-street.png diff --git a/src/docs/dev/images/one-street_1024.png b/src/docs/images/one-street_1024.png similarity index 100% rename from src/docs/dev/images/one-street_1024.png rename to src/docs/images/one-street_1024.png diff --git a/src/docs/manual.asciidoc b/src/docs/manual.asciidoc new file mode 100644 index 000000000..fc8660c7c --- /dev/null +++ b/src/docs/manual.asciidoc @@ -0,0 +1,13 @@ += Neo4j Spatial v{neo4j-version} = + +:neo4j-spatial-version: {neo4j-version} + +:leveloffset: 1 + +include::dev/introduction.txt[] + +:leveloffset: 1 + +include::dev/index.txt[] + +