Initial build of readthedocs

openjournals · Jul 1, 2018 · 218c678da87b0d979324191ae0d84529946af8d1 · 218c678
1 parent 2e51ec9
commit 218c678da87b0d979324191ae0d84529946af8d1
diff --git a/.gitignore b/.gitignore
@@ -17,3 +17,7 @@
 /tmp
 /.env
 .DS_Store
+  
+
+  
+# Ignore readthedocs build
+  
+
+  
+docs/_build
diff --git a/docs/Editors_workflow.md b/docs/Editors_workflow.md
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    = JOSS
+  
+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)
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,177 @@
+  
+# -*- 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 = 'JOSS'
+  
+copyright = '2018, Open Journals'
+  
+author = 'Arfon Smith & Open Journals community'
+  
+
+  
+# The short X.Y version
+  
+version = ''
+  
+# The full version, including alpha/beta/rc tags
+  
+release = ''
+  
+
+  
+# github_doc_root = 'https://github.com/openjournals/joss/tree/master/docs/'
+  
+
+  
+# -- 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.mathjax',
+  
+]
+  
+
+  
+# 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']
+  
+
+  
+from recommonmark.parser import CommonMarkParser
+  
+from recommonmark.transform import AutoStructify
+  
+
+  
+source_parsers = {
+  
+    '.md': CommonMarkParser,
+  
+}
+  
+
+  
+source_suffix = ['.rst', '.md']
+  
+
+  
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+  
+
+  
+# The name of the Pygments (syntax highlighting) style to use.
+  
+pygments_style = 'sphinx'
+  
+
+  
+
+  
+# -- 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 = '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 = 'JOSSdoc'
+  
+
+  
+
+  
+# -- 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, 'JOSS.tex', 'JOSS Documentation',
+  
+     'Open Journals', '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, 'joss', 'JOSS 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, 'JOSS', 'JOSS Documentation',
+  
+     author, 'JOSS', 'One line description of project.',
+  
+     'Miscellaneous'),
+  
+]
+  
+
+  
+
+  
+# -- Extension configuration -------------------------------------------------
+  
+# At the bottom of conf.py
+  
+# app setup hook
+  
+def setup(app):
+  
+    app.add_config_value('recommonmark_config', {
+  
+        'auto_toc_tree_section': 'Contents',
+  
+        'enable_eval_rst': True,
+  
+        'enable_auto_doc_ref': True,
+  
+    }, True)
+  
+    app.add_transform(AutoStructify)
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,2 @@
+  
+Contributing
+  
+============