Merge pull request #116 from gonsie/rtfd

Read the docs

.gitignore

@@ -64,3 +64,6 @@ Makefile.in
 # Vagrant/Ansible artifacts
 /devops/vagrant_ansible_inventory_*
 /devops/.vagrant
+
+# documentation build
+doc/build

Makefile.am

@@ -1,7 +1,7 @@
 AUTOMAKE_OPTIONS = foreign
 ACLOCAL_AMFLAGS = -I m4
 
-SUBDIRS = src doc
+SUBDIRS = src
 
 if EXPERIMENTAL_ENABLED
   SUBDIRS += experimental

configure.ac

@@ -50,9 +50,6 @@ AC_CHECK_FUNCS([endgrent endpwent getcwd lchown memset mkdir realpath rmdir strc
 ##
 AC_PROG_LIBTOOL
 
-# Check for nose test program.
-X_AC_PANDOC
-
 # Check for nose test program.
 X_AC_NOSETESTS
 
@@ -91,15 +88,11 @@ AC_CONFIG_FILES([Makefile                \
                  src/drm/Makefile        \
                  src/dstripe/Makefile    \
                  src/dwalk/Makefile      \
-                 doc/Makefile            \
-                 doc/man/Makefile        \
-                 doc/man/man1/Makefile   \
 ])
-#                 doc/html/Makefile       \
 
 # Check if we should build the experimental utilities.
 X_AC_EXPERIMENTAL
-if test [EXPERIMENTAL_ENABLED]; then 
+if test [EXPERIMENTAL_ENABLED]; then
 AC_CONFIG_FILES([experimental/Makefile           \
                  experimental/dparallel/Makefile \
                  experimental/dsh/Makefile       \

doc/.pip

@@ -0,0 +1 @@
+guzzle-sphinx-theme

doc/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = mpiFileUtils
+SOURCEDIR     = rst
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/README.md

@@ -1,3 +1,5 @@
-# Documentation Note
+# Documentation
 
-Please edit only markdown files and use autotools to regenerate the html files and man pages.
+Edits should be made to the `.rst` files.
+The documentation can be built with `make html` or `make man`.
+The generated files will be found in the `build` directory.