add latest conf.py

src/sphinx/conf.py

@@ -0,0 +1,380 @@
+# -*- coding: utf-8 -*-
+
+# #################################
+# ##### Sphinx Configuration  #####
+# #################################
+
+
+# Use the sbt-site Preprocess plugin to replace variables in this file with your values.
+# You'll need to:
+#  1. enable the sbt-site PreprocessPlugin
+#  2. set the preprocessing target so the the resulting config.py file will be put into /src/sphinx  (This is where the SphinxDoc task expects the config.py file to be.)
+#  3. ensure the PreprocessPlugin will do replacements in the config.py file by setting the preprocessIncludeFilter
+#  4. set the preprocessVars with the values you want replaced in the sphinx config.py file
+#
+#  Then you can run `sbt preprocess:makeSite`  to create all the documentation, or you can run `sbt preprocess:preprocess`
+#  if you just want to do the preprocessing (which will do the replacement and create the target config.py file).
+#
+#  Ex:
+#   Include these statements in your build.stb:
+#     enablePlugins(PreprocessPlugin)                                  // step #1
+#     target in Preprocess := baseDirectory.value / "src" / "sphinx"   // step #2
+#     preprocessIncludeFilter in Preprocess := "*.py"                  // step #3
+#
+#     // step #4:  set the values of the variables:
+#       val mainAuthor = "Alvin Alexander"
+#       preprocessVars in Preprocess := Map("PROJECT" -> normalizedName.value,
+#                 "SHORTCOPYRIGHTINFO" -> s"Copyright ${Year.now()} $mainAuthor",
+#                 "SHORTPROJECTVERSION" -> version.value,
+#                 "LONGPROJECTVERSION" -> version.value,
+#                 "AUTHORS" -> s"$mainAuthor, GrumpyCat",
+#                 "MAINAUTHOR" -> mainAuthor,
+#                 "SHORTPROJECTDESC" -> description.value,
+#                 "EPUBPUBLISHER" -> mainAuthor)
+#
+#  Then run the preprocess task(s) -- either preprocess:makeSite or preprocess:preprocess.
+#
+# -----------
+# Replacements are used to mainly provide project-specific information, or
+# to adjust or change a project version or copyright year, etc. (values that may change over time).
+#
+# In this file, replacements are not meant to change any layout or formatting settings.  But you
+#  can certainly edit this file and insert your own replacement variables (anything starting and ending with a @)
+#  to customize whatever you'd like.  (Don't forget to set the values in preprocessVars )
+#
+# Available replacements
+# ------------------------------------------------
+# sbt-rtfd-markdown-test              project name ex: sbt-native-packager
+# 2016 ashley engelund (weedy-sea-dragon @ github)   short copyright info ex: 2016 sbt-native-packager team
+# 0.23-SNAPSHOT  the short X.Y version of the project ex: 1.0
+# 0.23-SNAPSHOT   the long version of the project, including alpha, beta tags, etc. ex: 1.0-ALPHA
+# ashley engelund (weedy-sea-dragon @ github)              authors on the project
+# ashley engelund (weedy-sea-dragon @ github)           one (main or original) author for places where only one can be listed ex: Josh Suereth
+# sbt-rtfd-markdown-test     a short (one line) description of the project
+# ashley engelund (weedy-sea-dragon @ github)        publisher of the ePub version of this documentation ex: Josh Suereth
+# -------------------------------------------------
+
+
+#######################################################
+#
+# Oneshot documentation build configuration file, created by
+# sphinx-quickstart on Thu Dec 29 15:26:51 2011.
+#
+# 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.
+
+import sys, os
+import sphinx_rtd_theme
+
+# 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.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- 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 = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sbt-rtfd-markdown-test'
+copyright = u'2016 ashley engelund (weedy-sea-dragon @ github)'
+
+# 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.23-SNAPSHOT'
+# The full version, including alpha/beta/rc tags.
+release = '0.23-SNAPSHOT'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+import sphinx_rtd_theme
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# 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 themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Language to be used for generating the HTML full-text search index.
+# Sphinx supports the following languages:
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
+#html_search_language = 'en'
+
+# A dictionary with options for the search language support, empty by default.
+# Now only 'ja' uses this config value
+#html_search_options = {'type': 'default'}
+
+# The name of a javascript file (relative to the configuration directory) that
+# implements a search results scorer. If empty, the default will be used.
+#html_search_scorer = 'scorer.js'
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "sbt-rtfd-markdown-test"
+
+
+# -- 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]).
+latex_documents = [
+    (master_doc, 'Test.tex', u"sbt-rtfd-markdown-test",
+     u'Test', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- 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, 'test', u'sbt-rtfd-markdown-test',
+     u'ashley engelund (weedy-sea-dragon @ github)', 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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 = [
+      ('index', 'Oneshot', u'sbt-rtfd-markdown-test',
+       u'ashley engelund (weedy-sea-dragon @ github)',  'sbt-rtfd-markdown-test',
+       'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+# Markdown support
+
+#from recommonmark.parser import CommonMarkParser
+
+# The suffix of source filenames.
+source_suffix = ['.rst', '.md']
+
+source_parsers = {
+    #	'.md': CommonMarkParser,
+}
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u"sbt-rtfd-markdown-test"
+epub_author = u'ashley engelund (weedy-sea-dragon @ github)'
+epub_publisher = u'ashley engelund (weedy-sea-dragon @ github)'
+epub_copyright = u'2016 ashley engelund (weedy-sea-dragon @ github)'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# 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 tuple containing the cover image and cover page html template filenames.
+#epub_cover = ()
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True