Set up sphinx documentation

.gitignore

@@ -66,6 +66,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+sphinx-docs/_build/
 
 # PyBuilder
 target/

README.rst

@@ -1,6 +1,8 @@
 djiffy
 ======
 
+.. sphinx-start-marker-do-not-remove
+
 Django application to index and display IIIF Manifests for books
 
 .. image:: https://travis-ci.org/Princeton-CDH/djiffy.svg?branch=master
@@ -18,7 +20,8 @@ Django application to index and display IIIF Manifests for books
 
 **djiffy** is intended to be a reusable `Django`_ application for
 working with digitized book content provided via `IIIF Presentation`_
-manifests.
+manifests.  This is an *alpha* version and it does *not* yet support
+the full IIIF Presentation specification.
 
 
 .. _Django: https://www.djangoproject.com/
@@ -45,7 +48,7 @@ tagged release or branch::
         pip install git+https://github.com/Princeton-CDH/piffle.git@feature/python3-compatibility#egg=piffle
 
 
-configuration
+Configuration
 -------------
 
 Add `djiffy` to installed applications and make sure that `django.contrib.humanize`
@@ -78,7 +81,10 @@ Usage
 
 Import IIIF content using the `import_manifest` manage command.  This
 command can take an IIIF Collection or single Manifest, via local file
-or URL.  Imported content can be viewed in Django admin.
+or URL.  Imported content can be viewed in Django admin.::
+
+    python manage.py import_manifest http://url.for/iiif/manifest
+    python manage.py import_manifest /path/to/local/collection
 
 
 Development instructions

djiffy/management/commands/import_manifest.py

@@ -1,9 +1,14 @@
+'''
+Generic manage command for importing IIIF Collections or manifests
+nto the database. Supports collections and individual manifests,
+and local file paths as well as URLs.
+'''
+
 from django.core.management.base import BaseCommand
 
 from djiffy.importer import ManifestImporter
 
 class Command(BaseCommand):
-    '''Import IIIF Collections or Manifests into the local database.'''
 
     def add_arguments(self, parser):
         parser.add_argument('path', nargs='+',

setup.py

@@ -30,6 +30,7 @@
     tests_require=test_requirements,
     extras_require={
         'test': test_requirements,
+        'docs': ['sphinx']
     },
     author='CDH @ Princeton',
     author_email='[email protected]',

sphinx-docs/Makefile

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

sphinx-docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../CHANGELOG.rst

sphinx-docs/codedocs.rst

@@ -0,0 +1,32 @@
+Code Documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+Models
+------
+
+.. automodule:: djiffy.models
+    :members:
+
+Views
+-----
+
+.. automodule:: djiffy.views
+    :members:
+
+Import
+------
+
+.. automodule:: djiffy.importer
+    :members:
+
+Manage Commands
+---------------
+
+Import manifest
+^^^^^^^^^^^^^^^
+
+.. automodule:: djiffy.management.commands.import_manifest
+    :members:

sphinx-docs/conf.py

@@ -0,0 +1,168 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Djiffy documentation build configuration file, created by
+# sphinx-quickstart on Tue Jun 13 11:20:47 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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
+import django
+
+sys.path.insert(0, os.path.abspath('.'))
+
+os.environ['DJANGO_SETTINGS_MODULE'] = 'testsettings'
+django.setup()
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.coverage',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Djiffy'
+copyright = '2017, CDH @ Princeton'
+author = 'CDH @ Princeton'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- 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'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# 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']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Djiffydoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Djiffy.tex', 'Djiffy Documentation',
+     'CDH @ Princeton', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'djiffy', 'Djiffy Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Djiffy', 'Djiffy Documentation',
+     author, 'Djiffy', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}

sphinx-docs/index.rst

@@ -0,0 +1,26 @@
+.. Djiffy documentation master file, created by
+   sphinx-quickstart on Tue Jun 13 11:20:47 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Djiffy Documentation
+====================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   codedocs
+   Change Log <changelog>
+
+
+.. include:: ../README.rst
+    :start-after: sphinx-start-marker-do-not-remove
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`