diff --git a/docs/conf.py b/docs/conf.py index cbd1a69322..1425a598bc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # # GO Ontology documentation build configuration file, modeled after file created by -# sphinx-quickstart for Apollo project. Wednesday 2017-05-24. +# sphinx-quickstart. Wednesday 2017-08-04. # # by MMT # @@ -14,30 +14,43 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import sys -import os - # 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('.')) +import sys +import os +sys.path.append(os.path.abspath('exts')) + + # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' -sys.path.append(os.path.abspath('exts')) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ['markdowntransform'] - +extensions = [ + 'markdowntransform', + 'alabaster', +] # 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: +# +from recommonmark.parser import CommonMarkParser + +source_parsers = { + '.md': CommonMarkParser, +} +source_suffix = ['.rst', '.md'] + # The encoding of source files. # source_encoding = 'utf-8-sig' @@ -45,8 +58,9 @@ master_doc = 'index' # General information about the project. -project = u'go-ontology' -copyright = u'2017, go-ontology' +project = u'GO Ontology' +copyright = u'2017, Gene Ontology Consortium' +author = u'The GOC Ontology Team' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -59,7 +73,7 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -100,7 +114,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +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 @@ -178,7 +192,7 @@ #html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'go-ontologydoc' +htmlhelp_basename = 'go-ontology' # -- Options for LaTeX output --------------------------------------------- @@ -258,13 +272,3 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False - -# The suffix of source filenames. -from recommonmark.parser import CommonMarkParser - -# The suffix of source filenames. -source_suffix = ['.rst', '.md'] - -source_parsers = { - '.md': CommonMarkParser, -}