Merge pull request #362 from JrGoodle/docs

Docs

README.md

@@ -1,6 +1,7 @@
 # `clowder`
 [![Build Status](https://travis-ci.org/JrGoodle/clowder.svg)](https://travis-ci.org/JrGoodle/clowder)
 [![Coverage Status](https://coveralls.io/repos/github/JrGoodle/clowder/badge.svg?branch=master)](https://coveralls.io/github/JrGoodle/clowder?branch=master)
+[![Issue Count](https://codeclimate.com/github/JrGoodle/clowder/badges/issue_count.svg)](https://codeclimate.com/github/JrGoodle/clowder)
 [![PyPI version](https://badge.fury.io/py/clowder-repo.svg)](https://badge.fury.io/py/clowder-repo)
 [![Python version](https://img.shields.io/pypi/pyversions/clowder-repo.svg)](https://pypi.python.org/pypi/clowder-repo)
 [![License](https://img.shields.io/pypi/l/clowder-repo.svg)](https://pypi.python.org/pypi/clowder-repo)

clowder/setup.py

@@ -21,11 +21,7 @@
         'Topic :: Software Development :: Build Tools',
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.2',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5'
+        'Programming Language :: Python :: 3.6'
     ],
     packages=['clowder',
               'clowder.error',

clowder_test/setup.py

@@ -21,11 +21,7 @@
         'Topic :: Software Development :: Build Tools',
         'License :: OSI Approved :: MIT License',
         'Programming Language :: Python :: 2.7',
-        'Programming Language :: Python :: 3',
-        'Programming Language :: Python :: 3.2',
-        'Programming Language :: Python :: 3.3',
-        'Programming Language :: Python :: 3.4',
-        'Programming Language :: Python :: 3.5'
+        'Programming Language :: Python :: 3.6'
     ],
     packages=['clowder_test'],
     entry_points={

docs/clowder.util.rst

@@ -4,14 +4,6 @@ clowder.util package
 Submodules
 ----------
 
-clowder.util.clowder_yaml module
---------------------------------
-
-.. automodule:: clowder.util.clowder_yaml
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 clowder.util.connectivity module
 --------------------------------
 

docs/clowder.yaml.rst

@@ -0,0 +1,61 @@
+clowder\.yaml package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    clowder.yaml.validation
+
+Submodules
+----------
+
+clowder\.yaml\.loading module
+-----------------------------
+
+.. automodule:: clowder.yaml.loading
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.parsing module
+-----------------------------
+
+.. automodule:: clowder.yaml.parsing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.printing module
+------------------------------
+
+.. automodule:: clowder.yaml.printing
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.saving module
+----------------------------
+
+.. automodule:: clowder.yaml.saving
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.validating module
+--------------------------------
+
+.. automodule:: clowder.yaml.validating
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: clowder.yaml
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/clowder.yaml.validation.rst

@@ -0,0 +1,62 @@
+clowder\.yaml\.validation package
+=================================
+
+Submodules
+----------
+
+clowder\.yaml\.validation\.defaults module
+------------------------------------------
+
+.. automodule:: clowder.yaml.validation.defaults
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.validation\.forks module
+---------------------------------------
+
+.. automodule:: clowder.yaml.validation.forks
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.validation\.groups module
+----------------------------------------
+
+.. automodule:: clowder.yaml.validation.groups
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.validation\.projects module
+------------------------------------------
+
+.. automodule:: clowder.yaml.validation.projects
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.validation\.sources module
+-----------------------------------------
+
+.. automodule:: clowder.yaml.validation.sources
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+clowder\.yaml\.validation\.util module
+--------------------------------------
+
+.. automodule:: clowder.yaml.validation.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: clowder.yaml.validation
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/index.rst

@@ -35,6 +35,7 @@ clowder
    Models <clowder.model>
    Utils <clowder.util>
    Exceptions <clowder.error>
+   YAML Utilities <clowder.yaml>
 
 
 

script/server

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" || exit 1
+
+if [ "$1" == 'docs' ]; then
+    cd ..
+    osascript -e 'tell application "Safari" to open location "127.0.0.1:8000"'
+    sphinx-autobuild docs docs/_build/html
+    exit
+fi

script/update

@@ -31,6 +31,14 @@ if [ "$1" == 'website' ]; then
     exit
 fi
 
+if [ "$1" == 'docs' ]; then
+    cd ..
+    sphinx-apidoc -o docs clowder
+    rm docs/modules.rst
+    rm docs/setup.rst
+    exit
+fi
+
 VERSION=${1:-python3}
 
 ./clean 'clowder' || exit 1