Neo4j documentation assembler

Tool to filter and package documentation files, including executing a documentation-generating test and then install the assembled docs in the local repo.

License	GNU Affero General Public License, Version 3
Categories	Maven Build Tools Neo4J Data Databases
GroupId	org.neo4j.build.plugins
ArtifactId	docs-maven-plugin
Last Version	5
Release Date	Mar 1, 2012
Type	maven-plugin
Description	Neo4j documentation assembler Tool to filter and package documentation files, including executing a documentation-generating test and then install the assembled docs in the local repo.
Project URL	http://components.neo4j.org/docs-maven-plugin/5
Project Organization	The Neo4j Graph Database Project
Source Code Management	https://github.com/neo4j/docs-maven-plugin

Download docs-maven-plugin

Filename	Size
docs-maven-plugin-5.pom
docs-maven-plugin-5.jar	16 KB
docs-maven-plugin-5-sources.jar	7 KB
docs-maven-plugin-5-javadoc.jar	32 KB

How to add to project

Apache Maven

<plugin>
    <groupId>org.neo4j.build.plugins</groupId>
    <artifactId>docs-maven-plugin</artifactId>
    <version>5</version>
</plugin>

Dependencies

compile (6)

Group / Artifact	Type	Version
org.apache.maven : maven-core	jar	3.0.3
org.apache.maven : maven-plugin-api	jar	3.0.3
org.apache.maven.shared : maven-filtering	jar	1.0
org.codehaus.plexus : plexus-interpolation	jar	1.14
org.twdata.maven : mojo-executor	jar	2.0
org.codehaus.plexus : plexus-archiver	jar	1.2

test (1)

Group / Artifact	Type	Version
junit : junit	jar	4.9

Project Modules

There are no modules declared in this project.

Maven plugin to package docs

Add it to the project

<plugin>
  <artifactId>docs-maven-plugin</artifactId>
  <groupId>org.neo4j.build.plugins</groupId>
  <version>1</version>
  <!--  the directories below will be added by default,
    using the config element will _replace_ the defaults.
  <configuration>
    <sourceDirectories>
      <sourceDirectory>${basedir}/src/docs</sourceDirectory>
      <sourceDirectory>${project.build.directory}/docs</sourceDirectory>
    </sourceDirectories>
  </configuration>
   -->
</plugin>

Tip	Make sure to add the configuration to the plugin element and not to an execution, unless you want Maven builds and CLI invocations of the plugin to behave differently!

Filtering

The filtering is the usual Maven filtering being applied. Image files are not filtered.

To turn filtering on, set the filter property to true. Note that this can’t be set on directory level.

Use it from the command line

Note	If it’s not added to the project configuration, you need to invoke it like for example mvn org.neo4j.build.plugins:docs-maven-plugin:1:assemble

Build docs without building the project

mvn docs:assemble

• creates the docs.jar

• attaches the created jar to the project

• mostly interesting for use in the pom.xml

• mvn2 and mvn3

Build and install docs without building the project

mvn docs:install

• creates and then installs the docs.jar

• mvn3 only

• CLI only

mvn docs:install -Dtest=DocsTest

• executes test, then assembles and installs docs

• otherwise, like the example above

Neo4j

Versions

Version
5 Mar 1, 2012
4 Feb 29, 2012
3 Feb 10, 2012
2 Feb 6, 2012
1 Jan 24, 2012