documentation (#24)

.gitignore

@@ -50,6 +50,8 @@
 /_yardoc/
 /.yardoc/
 /doc/
+/docs/_build/
+/docs/_yard/
 
 # vim
 tags

README.md

@@ -1,6 +1,16 @@
 # Heliotropium
 
+[![Architecture](https://readthedocs.org/projects/heliotropium/badge/?version=latest)](https://heliotropium.readthedocs.io/en/latest/?badge=latest)
+[![Implementation](https://img.shields.io/badge/API_docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/github/mlibrary/heliotropium)
 [![Build Status](https://travis-ci.org/mlibrary/heliotropium.svg?branch=master)](https://travis-ci.org/mlibrary/heliotropium?branch=master)
 [![Coverage Status](https://coveralls.io/repos/github/mlibrary/heliotropium/badge.svg?branch=master)](https://coveralls.io/github/mlibrary/heliotropium?branch=master)
-[![API Docs](https://img.shields.io/badge/API_docs-rubydoc.info-blue.svg)](https://www.rubydoc.info/github/mlibrary/heliotropium)
-[![Documentation Status](https://readthedocs.org/projects/heliotropium/badge/?version=latest)](https://heliotropium.readthedocs.io/en/latest/?badge=latest)
+
+A [Heliotrope](https://github.com/mlibrary/heliotrope) support application.
+
+## Documentation
+
+* [Architecture](https://heliotropium.readthedocs.io/en/latest/?badge=latest)
+* [Implementation](https://www.rubydoc.info/github/mlibrary/heliotropium)
+
+
+## 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+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)

docs/conf.py

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+#import os
+#import sys
+#sys.path.insert(0, os.path.abspath('.'))
+
+#import guzzle_sphinx_theme
+
+# -- Project information -----------------------------------------------------
+
+project = u'Heliotropium'
+copyright = u'2019, Regents of the University of Michigan'
+author = u'University of Michigan'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+#    'guzzle_sphinx_theme',
+    'sphinx.ext.coverage',
+#    'sphinxcontrib.plantuml',
+#    'sphinxcontrib.httpdomain'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# -- httpdomain options
+
+http_index_shortname = 'api'
+http_index_localname = 'Chipmunk API'
+http_strict_mode = True

docs/conf.py.chipmunk

@@ -0,0 +1,59 @@
+# -*- coding: utf-8 -*-
+
+import guzzle_sphinx_theme
+
+# -- Project information -----------------------------------------------------
+
+project = u'Chipmunk'
+copyright = u'2019, Regents of the University of Michigan'
+author = u'University of Michigan'
+version = u''
+release = u''
+
+# -- General configuration ---------------------------------------------------
+
+extensions = [
+    'guzzle_sphinx_theme',
+    'sphinx.ext.coverage',
+    'sphinxcontrib.plantuml',
+    'sphinxcontrib.httpdomain'
+]
+
+templates_path = ['_templates']
+source_suffix = ['.rst']
+master_doc = 'index'
+language = None
+pygments_style = 'sphinx'
+
+exclude_patterns = [
+    '_build',
+    'Thumbs.db',
+    '.DS_Store',
+    '_yard'
+]
+
+todo_include_todos = False
+
+# -- Options for HTML output -------------------------------------------------
+
+html_theme_path = guzzle_sphinx_theme.html_theme_path()
+html_theme = 'guzzle_sphinx_theme'
+html_static_path = ['_static']
+
+html_theme_options = {
+    "project_nav_name": project,
+}
+
+html_sidebars = {
+    '**': [
+        'logo-text.html',
+        'globaltoc.html',
+        'searchbox.html',
+    ]
+}
+
+# -- httpdomain options
+
+http_index_shortname = 'api'
+http_index_localname = 'Chipmunk API'
+http_strict_mode = True

docs/conf.py.quick-start

@@ -0,0 +1,55 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Heliotropium'
+copyright = '2019, University of Michigan Library'
+author = 'University of Michigan Library'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']

docs/index.rst

@@ -0,0 +1,20 @@
+.. Heliotropium documentation master file, created by
+   sphinx-quickstart on Fri Jun 14 14:47:02 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Heliotropium's documentation!
+========================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,5 @@
+sphinx
+sphinx-autobuild
+sphinxcontrib-plantuml
+sphinxcontrib-httpdomain
+guzzle_sphinx_theme