docs/conf.py

   1 # -*- coding: utf-8 -*-
   2 """Configuration file for the Sphinx documentation builder.
   3
   4 This file does only contain a selection of the most common options. For a
   5 full list see the documentation:
   6
   7 * http://www.sphinx-doc.org/en/stable/config
   8
   9 """
  10
  11 from __future__ import division, print_function, unicode_literals
  12
  13 # from datetime import datetime
  14
  15 from recommonmark.parser import CommonMarkParser
  16
  17 # You should have received a copy of the GNU Affero General Public License
  18 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19 __author__     = 'Imran Iqbal'                                     # noqa: E221
  20 __copyright__  = 'Copyright (C) 2019, MYII'                        # noqa: E221
  21 __license__    = 'Apache-2.0'                                      # noqa: E221
  22 __version__    = 'latest'                                          # noqa: E221
  23 __maintainer__ = 'Imran Iqbal'                                     # noqa: E221
  24
  25
  26 # -- Project information -----------------------------------------------------
  27
  28 project = 'template-formula'
  29 copyright = __copyright__.replace('Copyright (C) ', '')  # noqa: A001
  30 author = __author__
  31 version = __version__
  32 release = __version__
  33
  34
  35 # -- General configuration ---------------------------------------------------
  36
  37 # If your documentation needs a minimal Sphinx version, state it here.
  38 #
  39 # needs_sphinx = '1.0'
  40
  41 # Add any Sphinx extension module names here, as strings. They can be
  42 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  43 # ones.
  44 extensions = []
  45
  46 # Add any paths that contain templates here, relative to this directory.
  47 templates_path = ['templates', '_templates', '.templates']
  48
  49 # The suffix(es) of source filenames.
  50 # You can specify multiple suffix as a list of string:
  51 #
  52 source_suffix = ['.rst', '.md']
  53
  54 # The master toctree document.
  55 master_doc = 'index'
  56
  57 # The language for content autogenerated by Sphinx. Refer to documentation
  58 # for a list of supported languages.
  59 #
  60 # This is also used if you do content translation via gettext catalogs.
  61 # Usually you set "language" from the command line for these cases.
  62 language = None
  63
  64 # List of patterns, relative to source directory, that match files and
  65 # directories to ignore when looking for source files.
  66 # This pattern also affects html_static_path and html_extra_path .
  67 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
  68
  69 # The name of the Pygments (syntax highlighting) style to use.
  70 pygments_style = 'sphinx'
  71
  72
  73 # -- Options for the reStructuredText parser ---------------------------------
  74
  75 file_insertion_enabled = False
  76
  77
  78 # -- Options for HTML output -------------------------------------------------
  79
  80 # The theme to use for HTML and HTML Help pages.  See the documentation for
  81 # a list of builtin themes.
  82 #
  83 html_theme = 'sphinx_rtd_theme'
  84
  85 # Theme options are theme-specific and customize the look and feel of a theme
  86 # further.  For a list of options available for each theme, see the
  87 # documentation.
  88 #
  89 # html_theme_options = {}
  90
  91 # Add any paths that contain custom static files (such as style sheets) here,
  92 # relative to this directory. They are copied after the builtin static files,
  93 # so a file named "default.css" will overwrite the builtin "default.css".
  94 html_static_path = ['_static']
  95
  96 # Custom sidebar templates, must be a dictionary that maps document names
  97 # to template names.
  98 #
  99 # The default sidebars (for documents that don't match any pattern) are
 100 # defined by theme itself.  Builtin themes are using these templates by
 101 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 102 # 'searchbox.html']``.
 103 #
 104 # html_sidebars = {}
 105
 106
 107 # -- Options for HTMLHelp output ---------------------------------------------
 108
 109 # Output file base name for HTML help builder.
 110 htmlhelp_basename = 'template-formula'
 111
 112
 113 # -- Options for Markdown output ---------------------------------------------
 114
 115 source_parsers = {
 116     '.md': CommonMarkParser,
 117 }
 118
 119
 120 # -- Options for LaTeX output ------------------------------------------------
 121
 122 latex_elements = {
 123     # The paper size ('letterpaper' or 'a4paper').
 124     #
 125     # 'papersize': 'letterpaper',
 126
 127     # The font size ('10pt', '11pt' or '12pt').
 128     #
 129     # 'pointsize': '10pt',
 130
 131     # Additional stuff for the LaTeX preamble.
 132     #
 133     # 'preamble': '',
 134
 135     # Latex figure (float) alignment
 136     #
 137     # 'figure_align': 'htbp',
 138 }
 139
 140 # Grouping the document tree into LaTeX files. List of tuples
 141 # (source start file, target name, title,
 142 #  author, documentclass [howto, manual, or own class]).
 143 latex_documents = [
 144     (
 145         'index',
 146         'template-formula.tex',
 147         u'template-formula Documentation',
 148         u'',
 149         'manual',
 150     ),
 151 ]
 152
 153
 154 # -- Functions: `setup`, docstring preprocessing, etc. -----------------------
 155
 156 def setup(app):
 157     """Prepare the Sphinx application object.
 158
 159     Used for providing a custom CSS file for override styles.
 160
 161     Parameters
 162     ----------
 163     app : object
 164         The Sphinx application object.
 165
 166     Returns
 167     -------
 168     app : object
 169         The Sphinx application object.
 170
 171     """
 172     app.add_stylesheet('css/custom.css')
 173     return app