Use Sphinx as documentation tool

Author: tatsuhiro-t

README.rst

@@ -1,34 +1,52 @@
-Argparse4j - The command line argument parser library
-=====================================================
+Argparse4j - The Java command-line argument parser library
+==========================================================
 
-The argparse4j is a command line argument parser library for Java
-based on Python's argparse.
+Argparse4j is a command line argument parser library for Java based
+on Python's
+`argparse <http://docs.python.org/3/library/argparse.html>`_ module.
 
-To see how to use argparse4j, see http://argparse4j.sourceforge.net/
+Argparse4j is available in Maven central repository:
+
+.. code-block:: xml
+
+  <dependency>
+    <groupId>net.sourceforge.argparse4j</groupId>
+    <artifactId>argparse4j</artifactId>
+    <version>0.3.2</version>
+  </dependency>
 
 There are still missing features which exist in argparse but not in
 argparse4j, but there are also new features which only exist in
 argparse4j.
 
-Here is a summary of features:
+Here is summary of features:
 
 * Supported positional arguments and optional arguments.
 * Variable number of arguments.
 * Generates well formatted line-wrapped help message.
 * Suggests optional arguments/sub-command if unrecognized
-  arguments/sub-command were given, e.g., ``unrecognized argument
-  '--tpye'. Did you mean: --type``.
+  arguments/sub-command were given, e.g.:
+
+  .. code-block:: console
+
+    unrecognized argument '--tpye'
+    Did you mean:
+      --type
+
 * Takes into account East Asian Width ambiguous characters when
   line-wrap.
 * Sub-commands like, ``git add``.
 * Sub-command alias names, e.g., ``co`` for ``checkout``.
-* Customizable option prefix characters, e.g., ``+f`` and ``/h``.
+* Customizable option prefix characters, e.g. ``+f`` and ``/h``.
 * Print default values in help message.
 * Choice from given collection of values.
 * Type conversion from option strings.
-* Can directly assign values into user defined classes using
-  annotation.
-* Group arguments so that it will be printed in help message in more
-  readable way.
+* Can directly assign values into user defined classes using annotation.
+* Group arguments so that it will be printed in help message in
+  more readable way.
 * Mutually exclusive argument group.
 * Read additional arguments from file.
+* Argument/sub-command abbreviations.
+
+The primary documentation is done using `Sphinx
+<http://sphinx-doc.org/>`_.  You need Sphinx to run ``mvn site``.

pom.xml

@@ -107,6 +107,26 @@
 				<artifactId>maven-site-plugin</artifactId>
 				<version>3.0</version>
 			</plugin>
+			<plugin>
+				<groupId>org.codehaus.mojo</groupId>
+				<artifactId>exec-maven-plugin</artifactId>
+				<version>1.2.1</version>
+				<executions>
+					<execution>
+						<id>sphinx-doc</id>
+						<phase>site</phase>
+						<goals>
+							<goal>exec</goal>
+						</goals>
+						<configuration>
+							<executable>sphinx-make-html</executable>
+							<arguments>
+								<argument>${project.version}</argument>
+							</arguments>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
 			<plugin>
 				<artifactId>maven-assembly-plugin</artifactId>
 				<version>2.2.1</version>

sphinx-make-html

@@ -0,0 +1,5 @@
+#!/bin/sh -e
+echo "Building sphinx documentation for version $1"
+cd src/site/sphinx
+make html PACKAGE_VERSION=$1
+cp -vr _build/html/* ../../../target/site/