Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 1.05 KB

README.asciidoc

File metadata and controls

35 lines (20 loc) · 1.05 KB

About Neo4j Manual

The documents use the asciidoc format, see:

Building the documentation

Python is required, as well as graphviz, bash and make.

Apache Maven together with Make are used to unpack the pieces of the manual and to execute asciidoc on them. Note that running parallel jobs with Make (-j option) is not supported.

To build the documentation, use:
mvn clean install
This will produce the manual (in 'target/docbkx/webhelp/'). Note that when inspecting the result using a file:// URL the navigation tree won’t load in Chrome. If you need to see the tree, use a different browser or serve the files from a local webserver.

To build all dependencies of the manual, use the following at the top level of the repository:
mvn clean install -DdocsBuild

With brew on OSX

Install libraries

brew install graphviz libtool

With apt-get on Ubuntu

sudo apt-get install graphviz maven make