documentation start

oduwsdl · Jul 5, 2019 · 65e5d93c9c408a604d315df106fb130352a1ca97 · 65e5d93
1 parent f8b92c3
commit 65e5d93c9c408a604d315df106fb130352a1ca97
diff --git a/docs/Makefile b/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 	  = Raintale
+  
+SOURCEDIR     = source
+  
+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)
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,36 @@
+  
+@ECHO OFF
+  
+
+  
+pushd %~dp0
+  
+
+  
+REM Command file for Sphinx documentation
+  
+
+  
+if "%SPHINXBUILD%" == "" (
+  
+	set SPHINXBUILD=sphinx-build
+  
+)
+  
+set SOURCEDIR=source
+  
+set BUILDDIR=build
+  
+set SPHINXPROJ=Raintale
+  
+
+  
+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%
+  
+goto end
+  
+
+  
+:help
+  
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+  
+
+  
+:end
+  
+popd
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,175 @@
+  
+# -*- coding: utf-8 -*-
+  
+#
+  
+# Configuration file for the Sphinx documentation builder.
+  
+#
+  
+# This file does only contain 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 = u'Raintale'
+  
+copyright = u'2019, Shawn M. Jones'
+  
+author = u'Shawn M. Jones'
+  
+
+  
+# The short X.Y version
+  
+version = u''
+  
+# The full version, including alpha/beta/rc tags
+  
+release = u'0.2019.06.17.193810'
+  
+
+  
+
+  
+# -- 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',
+  
+]
+  
+
+  
+# 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'
+  
+
+  
+# 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 pattern also affects html_static_path and html_extra_path.
+  
+exclude_patterns = []
+  
+
+  
+# The name of the Pygments (syntax highlighting) style to use.
+  
+pygments_style = None
+  
+
+  
+
+  
+# -- 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'
+  
+html_theme = 'sphinx_rtd_theme'
+  
+
+  
+# 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']
+  
+
+  
+# Custom sidebar templates, must be a dictionary that maps document names
+  
+# to template names.
+  
+#
+  
+# The default sidebars (for documents that don't match any pattern) are
+  
+# defined by theme itself.  Builtin themes are using these templates by
+  
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+  
+# 'searchbox.html']``.
+  
+#
+  
+# html_sidebars = {}
+  
+
+  
+
+  
+# -- Options for HTMLHelp output ---------------------------------------------
+  
+
+  
+# Output file base name for HTML help builder.
+  
+htmlhelp_basename = 'Raintaledoc'
+  
+
+  
+
+  
+# -- 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, 'Raintale.tex', u'Raintale Documentation',
+  
+     u'Shawn M. Jones', '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, 'raintale', u'Raintale 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, 'Raintale', u'Raintale Documentation',
+  
+     author, 'Raintale', 'One line description of project.',
+  
+     'Miscellaneous'),
+  
+]
+  
+
+  
+
+  
+# -- Options for Epub output -------------------------------------------------
+  
+
+  
+# Bibliographic Dublin Core info.
+  
+epub_title = project
+  
+
+  
+# The unique identifier of the text. This can be a ISBN number
+  
+# or the project homepage.
+  
+#
+  
+# epub_identifier = ''
+  
+
+  
+# A unique identification for the text.
+  
+#
+  
+# epub_uid = ''
+  
+
+  
+# A list of files that should not be packed into the epub file.
+  
+epub_exclude_files = ['search.html']
diff --git a/docs/source/creating_story.rst b/docs/source/creating_story.rst
@@ -0,0 +1,14 @@
+  
+.. _building_story:
+  
+
+  
+Building Your Story
+  
+===================
+  
+
+  
+Raintale stories consist of two main features: a title and a list of memento URLs (URI-Ms).
+  
+
+  
+Simple Text File And Title
+  
+--------------------------
+  
+
+  
+
+  
+
+  
+Complex Story With JSON
+  
+-----------------------
diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -0,0 +1,6 @@
+  
+Getting Started
+  
+===============
+  
+
+  
+Raintale uses Docker to ensure that users have everything needed to run Raintale quickly.
+  
+
+  
+Raintale only works for URI-Ms from Memento-compliant web archives. It will not work for live web resources.
diff --git a/docs/source/images/raintale-html-example.png b/docs/source/images/raintale-html-example.png
diff --git a/docs/source/images/raintale-logo.png b/docs/source/images/raintale-logo.png
diff --git a/docs/source/images/raintale-twitter-example.png b/docs/source/images/raintale-twitter-example.png
diff --git a/docs/source/images/thumbcol4story_2950.png b/docs/source/images/thumbcol4story_2950.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,35 @@
+  
+.. Raintale documentation master file, created by
+  
+   sphinx-quickstart on Mon Jul  1 16:40:12 2019.
+  
+   You can adapt this file completely to your liking, but it should at least
+  
+   contain the root `toctree` directive.
+  
+
+  
+Raintale: Storytelling for Web Archives
+  
+====================================
+  
+
+  
+.. image:: images/raintale-logo.png
+  
+
+  
+What story do you want to tell with web archives?
+  
+
+  
+Raintale is a utility for publishing social media stories from groups of archived web pages (mementos). Raintale uses `MementoEmbed <https://github.com/oduwsdl/MementoEmbed>`_ to extract memento information and then publishes a story with the given **storyteller**, to a static file or an online social media service. A Raintale user supplies a file containing a list of memento URLs, a story title, and a storyteller to use for publishing the story. 
+  
+
+  
+Raintale is quite configurable, providing different publishing options as storytellers and file formats. Users may also provide different presets to configure how these storytellers format their stories. Finally, Raintale accepts a template file as an argument, allowing users to format their own stories.
+  
+
+  
+For example, the HTML storyteller will use the default preset to render the story into an HTML file as seen below.
+  
+
+  
+.. image:: images/raintale-html-example.png
+  
+
+  
+The Twitter storyteller will use the default preset to publish the story to Twitter as a tweets with a series of replies shown in the screenshot below.
+  
+
+  
+.. image:: images/raintale-twitter-example.png
+  
+
+  
+
+  
+
+  
+.. toctree::
+  
+   :maxdepth: 2
+  
+
+  
+   getting_started
+  
+   creating_story
+  
+   raintale_options
+  
+   templates
+  
+
+  
+
diff --git a/docs/source/license.rst b/docs/source/license.rst
@@ -0,0 +1,24 @@
+  
+License
+  
+=======
+  
+
+  
+MIT License
+  
+
+  
+Copyright (c) 2018 ODU Web Science / Digital Libraries Research Group
+  
+
+  
+Permission is hereby granted, free of charge, to any person obtaining a copy
+  
+of this software and associated documentation files (the "Software"), to deal
+  
+in the Software without restriction, including without limitation the rights
+  
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  
+copies of the Software, and to permit persons to whom the Software is
+  
+furnished to do so, subject to the following conditions:
+  
+
+  
+The above copyright notice and this permission notice shall be included in all
+  
+copies or substantial portions of the Software.
+  
+
+  
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  
+SOFTWARE.
diff --git a/docs/source/raintale_options.rst b/docs/source/raintale_options.rst
@@ -0,0 +1,2 @@
+  
+Raintale Options
+  
+================