Merge branch 'release/0.1.0'

.gitignore

@@ -0,0 +1 @@
+build

Makefile

@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  dirhtml   to make HTML files named index.html in directories"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  qthelp    to make HTML files and a qthelp project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/HydrologyThematicExploitationPlatform.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/HydrologyThematicExploitationPlatform.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

README.md

@@ -1,2 +1,58 @@
-# documentation
-Hydrology Thematic Exploitation guide http://hydrology-tep.github.io/documentation
+# Hydrology Thematic Exploitation Platform Documentation
+
+This is the official repository of Hydrology Thematic Exploitation Platform Documentation. This
+documentation is live at:
+[http://hydrology-tep.github.io/documentation](http://hydrology-tep.github.io/documentation).
+
+You are encouraged to fork this repo and send us pull requests!
+
+## Getting started
+
+Here's the procedure to install the required packages on a CentOS 6.x
+
+```
+sudo yum install python-sphinx
+sudo yum install python-pip
+```
+
+As root do:
+
+```
+pip install sphinx_bootstrap_theme
+```
+
+Back as your user, do:
+
+```
+git clone [email protected]:hydrology-tep/documentation.git
+cd documentation
+```
+
+If needed, set your github information
+
+```
+git config --global user.name <github username>
+git config --global user.email <email address>
+```
+
+## Building
+
+Build the documentation by running ``make html``.
+
+## Publish the documentation
+
+``make html`` creates a ``build`` folder in the *documentation* local repository.
+
+As root, do:
+
+```
+cd /var/www/html
+ln -s $HOME/documentation/build/html/ documentation
+chown apache:apache documentation
+```
+
+Open you browser at the address http://127.0.0.1/documentation
+
+## This documentation is built with sphinx-doc
+
+[More information](http://sphinx-doc.org/).

check_sphinx.py

@@ -0,0 +1,15 @@
+import py
+import subprocess
+
+def test_linkcheck(tmpdir):
+    doctrees = tmpdir.join("_build/doctrees")
+    htmldir = tmpdir.join("_build/html")
+    subprocess.check_call(["sphinx-build", "-W", "-blinkcheck", "-d",
+        str(doctrees), "source", str(htmldir)])
+
+
+def test_build_docs(tmpdir):
+    doctrees = tmpdir.join("_build/doctrees")
+    htmldir = tmpdir.join("_build/html")
+    subprocess.check_call([ "sphinx-build", "-n", "-W", "-bhtml", "-d",
+        str(doctrees), "source", str(htmldir)])