From 360adab97fcb6c91fb93a6317fefaf8e7a624526 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benjamin=20Melan=C3=A7on?= Date: Sun, 17 Jun 2018 16:25:25 -0400 Subject: [PATCH] Update (largely replace with new sphinx-quickstart) config file --- conf.py | 93 ++++++++++++++++++++++++++++++++------------------------- 1 file changed, 53 insertions(+), 40 deletions(-) diff --git a/conf.py b/conf.py index 8c641f6..5baa2df 100644 --- a/conf.py +++ b/conf.py @@ -1,16 +1,12 @@ # -*- coding: utf-8 -*- # -# Agaric public documentation build configuration file, created by -# sphinx-quickstart on Wed May 24 12:32:59 2017 (well, copied from Drutopia). +# Configuration file for the Sphinx documentation builder. # -# 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. +# 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 @@ -21,7 +17,19 @@ # sys.path.insert(0, os.path.abspath('.')) -# -- General configuration ------------------------------------------------ +# -- Project information ----------------------------------------------------- + +project = u'Agaric Collective' +copyright = u'2018, Benjamin Melançon, Michele Metts, Mauricio Dinarte, David Valdez, Clayton Dewey' +author = u'Benjamin Melançon, Michele Metts, Mauricio Dinarte, David Valdez, Clayton Dewey' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'' + + +# -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # @@ -30,7 +38,9 @@ # 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.ifconfig'] +extensions = [ + 'sphinx.ext.todo', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -73,24 +83,19 @@ 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'] +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = [u'_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 ---------------------------------------------- - -# import sphinx_rtd_theme +# -- 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' +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 @@ -101,23 +106,26 @@ todo_include_todos = False # 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 = [sphinx_rtd_theme.get_html_theme_path()] +html_static_path = ['_static'] -html_context = { - "display_gitlab": True, # Integrate Gitlab - "gitlab_user": "agaric", # Organization - "gitlab_repo": "documentation", # Repo name - "gitlab_version": "master", # Version - "conf_py_path": "/", # Path in the checkout to the docs root -} +# 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 ------------------------------------------ + +# -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = 'docs-agaric' -# -- Options for LaTeX output --------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). @@ -141,35 +149,34 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'docs-agaric.tex', u'Agaric Documentation', - u'Agaric', 'manual'), + (master_doc, 'AgaricCollective.tex', u'Agaric Collective Documentation', + u'Benjamin Melançon, Michele Metts, Mauricio Dinarte, David Valdez, Clayton Dewey', 'manual'), ] -# -- Options for manual page output --------------------------------------- +# -- 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, 'drutopia', u'Drutopia Documentation', + (master_doc, 'agariccollective', u'Agaric Collective Documentation', [author], 1) ] -# -- Options for Texinfo output ------------------------------------------- +# -- 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, 'Drutopia', u'Drutopia Documentation', - author, 'Drutopia', 'One line description of project.', + (master_doc, 'AgaricCollective', u'Agaric Collective Documentation', + author, 'AgaricCollective', 'One line description of project.', 'Miscellaneous'), ] - -# -- Options for Epub output ---------------------------------------------- +# -- Options for Epub output ------------------------------------------------- # Bibliographic Dublin Core info. epub_title = project @@ -190,3 +197,9 @@ epub_copyright = copyright epub_exclude_files = ['search.html'] +# -- Extension configuration ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True \ No newline at end of file