Merge pull request #1 from bird-house/birdhouse

updated sphinx docs

.travis.yml

@@ -4,13 +4,11 @@ branches:
     - master
     - develop
     - birdhouse
-sudo: true
+sudo: false
 python:
   # We don't actually use the Travis Python, but this keeps it organized.
   - "2.7"
 install:
-  - sudo apt-get update -y
-  - sudo apt-get install -y libuuid1 uuid-dev bc
   - wget http://repo.continuum.io/miniconda/Miniconda-latest-Linux-x86_64.sh -O miniconda.sh;
   - bash miniconda.sh -b -p $HOME/miniconda
   - export PATH="$HOME/miniconda/bin:$PATH"
@@ -24,7 +22,7 @@ install:
   # Replace dep1 dep2 ... with your dependencies
   - conda config --add channels birdhouse
   - conda config --add channels ioos
-  - conda install -q libnetcdf hdf5 zlib udunits2
+  - conda install -q libnetcdf hdf5 zlib udunits2 libuuid
 
   # Get build script
   - export PREFIX="$HOME/miniconda"
@@ -33,7 +31,7 @@ install:
   - echo "CFLAGS=\"-O2 -Wall\"" >> install_configure 
   - echo "CXXFLAGS=\"-O2 -Wall -D NC4\"" >> install_configure
   - echo "LIB=\"${PREFIX}/lib\"" >> install_configure
-  - echo "INCLUDE=\"${PREFIX}/include\":/usr/include/uuid" >> install_configure
+  - echo "INCLUDE=\"${PREFIX}/include\"" >> install_configure
 
 script:
   - touch .ignore_GitHub

CHANGES.rst

@@ -0,0 +1,25 @@
+.. _changelog:
+
+================
+ Change History
+================
+
+.. _version-0.5:
+
+0.5
+===
+:release-date: TBA
+
+- packaged as conda.
+- travis continous integration added.
+- published docs as sphinx on ReadTheDocs.
+
+
+.. _version-0.4:
+
+0.4
+===
+:release-date: 2014-mm-dd
+
+- CORDEX checker added ...
+

DoW.txt

@@ -8,4 +8,4 @@ for solving a problem whose incorrect solution could result in injury to a perso
 loss of property.  You use this package at your own risk. 
 The author and publisher disclaim all liability for direct, 
 incidental or consequential damages resulting from your use 
-of the programs, scipts or anything else in this book.
+of the programs, scripts or anything else in this book.

README.rst

@@ -0,0 +1,77 @@
+=================================================
+QA-DKRZ - Quality Assurance Tool for Climate Data
+=================================================
+
+|build-status| |conda-install|
+
+:Version: 0.5.x
+
+The QA tool is a quality assurance checker for metadata in climate data (NetCDF files). The tool checks
+the `CF-Conventions`_ conformance (Climate and Forecast Conventions) and also projects conventions for CMIP5 and CORDEX.
+
+.. note:: The QA tool is still in a testing stage.
+
+.. _`CF-conventions`: http://cfconventions.org/
+
+Getting Started
+===============
+
+The easiest way to install the QA tool is to use the conda package manager:
+
+.. code-block:: bash
+
+   $ conda install -c birdhouse qa-dkrz
+
+See :ref:`installation` for details and how to install from source. 
+
+You can now run for example the CF-checker on a NetCDF file:
+
+.. code-block:: bash
+
+   $ dkrz-cf-checker -h
+   $ dkrz-cf-checker my_tasmax.nc
+
+See more :ref:`examples` to get started.
+
+Documentation
+-------------
+
+QA Tool is using Sphinx, and the latest documentation can be found on `ReadTheDocs`_:
+
+    http://qa-dkrz.readthedocs.org
+
+.. _`ReadTheDocs`:  http://qa-dkrz.readthedocs.org
+
+Getting Help
+============
+
+Please, direct questions or comments to hollweg@dkrz.de
+
+Mailing list
+------------
+
+Join the mailing list ...
+
+
+Bug tracker
+===========
+
+If you have any suggestions, bug reports or annoyances please report them
+to our issue tracker at https://github.com/IS-ENES-Data/QA-DKRZ/issues
+
+Contributing
+============
+
+Development of `QA DKRZ` happens at Github: https://github.com/IS-ENES-Data/QA-DKRZ
+
+You are highly encouraged to participate in the development.
+
+License
+=======
+
+Please see the *Disclaimer of Warranty* (`DoW.txt`) file in the top distribution directory.
+
+.. |build-status| image:: https://travis-ci.org/IS-ENES-Data/QA-DKRZ.svg?branch=master
+   :target: https://travis-ci.org/IS-ENES-Data/QA-DKRZ
+.. |conda-install| image:: https://anaconda.org/birdhouse/qa-dkrz/badges/installer/conda.svg
+   :target: https://anaconda.org/birdhouse/qa-dkrz

docs/sphinx/changelog.rst

@@ -0,0 +1 @@
+../../CHANGES.rst

docs/sphinx/faq.rst

@@ -0,0 +1,11 @@
+============================
+ Frequently Asked Questions
+============================
+
+Questions
+=========
+
+Q: Why does ...?
+--------------------------------------
+**Answer**: Just because ...
+

docs/sphinx/glossary.rst

@@ -0,0 +1,10 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+   :sorted:
+
+   Quality Assurance
+      Quality assurance (QA) is a way of preventing mistakes ... (Wikipedia).

docs/sphinx/index.rst

@@ -3,15 +3,23 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to QA-DKRZ's documentation!
-===================================
+QA-DKRZ documentation
+=====================
 
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   qa-user-manual
+   introduction
+   userguide/index
+
+.. toctree::
+    :maxdepth: 1
+
+    faq
+    glossary
+    changelog
 
 
 Indices and tables

docs/sphinx/introduction.rst

@@ -0,0 +1 @@
+../../README.rst