The documents use the asciidoc format, see:
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
|
Note
|
When doing partial builds, note that the neo4j-manual-contents module (in manual/contents) has to be built as well.
All the content is collected there; the neo4j-manual module (in manual) only renders it.
|