doc/conf.py

   1 # -*- coding: utf-8 -*-
   2 #
   3 # Vis Editor documentation build configuration file, created by
   4 # sphinx-quickstart on Fri Apr 28 21:45:05 2017.
   5 #
   6 # This file is execfile()d with the current directory set to its
   7 # containing dir.
   8 #
   9 # Note that not all possible configuration values are present in this
  10 # autogenerated file.
  11 #
  12 # All configuration values have a default; values that are commented out
  13 # serve to show the default.
  14
  15 # If extensions (or modules to document with autodoc) are in another directory,
  16 # add these directories to sys.path here. If the directory is relative to the
  17 # documentation root, use os.path.abspath to make it absolute, like shown here.
  18 #
  19 import os
  20 import sys
  21 import subprocess
  22 # sys.path.insert(0, os.path.abspath('.'))
  23
  24 # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
  25 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
  26
  27 print subprocess.check_output('mkdir -p build/doxygen && doxygen', shell=True)
  28
  29 breathe_projects = {
  30     'vis': 'build/doxygen/xml'
  31 }
  32
  33 breathe_default_project = "vis"
  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 = ['breathe', 'sphinx.ext.mathjax' ]
  45
  46 mathjax_path = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
  47
  48 # Add any paths that contain templates here, relative to this directory.
  49 templates_path = ['_templates']
  50
  51 # The suffix(es) of source filenames.
  52 # You can specify multiple suffix as a list of string:
  53 #
  54 # source_suffix = ['.rst', '.md']
  55 source_suffix = '.rst'
  56
  57 # The master toctree document.
  58 master_doc = 'index'
  59
  60 # General information about the project.
  61 project = u'Vis Editor'
  62 copyright = u'2017, Marc André Tanner'
  63 author = u'Marc André Tanner'
  64
  65 # The version info for the project you're documenting, acts as replacement for
  66 # |version| and |release|, also used in various other places throughout the
  67 # built documents.
  68 #
  69 # The short X.Y version.
  70 version = u'0.3'
  71 # The full version, including alpha/beta/rc tags.
  72 release = u'0.3'
  73
  74 # The language for content autogenerated by Sphinx. Refer to documentation
  75 # for a list of supported languages.
  76 #
  77 # This is also used if you do content translation via gettext catalogs.
  78 # Usually you set "language" from the command line for these cases.
  79 language = None
  80
  81 # List of patterns, relative to source directory, that match files and
  82 # directories to ignore when looking for source files.
  83 # This patterns also effect to html_static_path and html_extra_path
  84 exclude_patterns = []
  85
  86 # The name of the Pygments (syntax highlighting) style to use.
  87 pygments_style = 'sphinx'
  88
  89 # If true, `todo` and `todoList` produce output, else they produce nothing.
  90 todo_include_todos = False
  91
  92 default_role = "any"
  93
  94 # -- Options for HTML output ----------------------------------------------
  95
  96 # The theme to use for HTML and HTML Help pages.  See the documentation for
  97 # a list of builtin themes.
  98 #
  99 # html_theme = 'alabaster'
 100
 101 # Theme options are theme-specific and customize the look and feel of a theme
 102 # further.  For a list of options available for each theme, see the
 103 # documentation.
 104 #
 105 # html_theme_options = {}
 106
 107 # Add any paths that contain custom static files (such as style sheets) here,
 108 # relative to this directory. They are copied after the builtin static files,
 109 # so a file named "default.css" will overwrite the builtin "default.css".
 110 html_static_path = ['_static']
 111
 112
 113 # -- Options for HTMLHelp output ------------------------------------------
 114
 115 # Output file base name for HTML help builder.
 116 htmlhelp_basename = 'VisEditordoc'
 117
 118
 119 # -- Options for LaTeX output ---------------------------------------------
 120
 121 latex_elements = {
 122     # The paper size ('letterpaper' or 'a4paper').
 123     #
 124     # 'papersize': 'letterpaper',
 125
 126     # The font size ('10pt', '11pt' or '12pt').
 127     #
 128     # 'pointsize': '10pt',
 129
 130     # Additional stuff for the LaTeX preamble.
 131     #
 132     # 'preamble': '',
 133
 134     # Latex figure (float) alignment
 135     #
 136     # 'figure_align': 'htbp',
 137 }
 138
 139 # Grouping the document tree into LaTeX files. List of tuples
 140 # (source start file, target name, title,
 141 #  author, documentclass [howto, manual, or own class]).
 142 latex_documents = [
 143     (master_doc, 'VisEditor.tex', u'Vis Editor Documentation',
 144      u'Marc André Tanner', 'manual'),
 145 ]
 146
 147
 148 # -- Options for manual page output ---------------------------------------
 149
 150 # One entry per manual page. List of tuples
 151 # (source start file, name, description, authors, manual section).
 152 man_pages = [
 153     (master_doc, 'viseditor', u'Vis Editor Documentation',
 154      [author], 1)
 155 ]
 156
 157
 158 # -- Options for Texinfo output -------------------------------------------
 159
 160 # Grouping the document tree into Texinfo files. List of tuples
 161 # (source start file, target name, title, author,
 162 #  dir menu entry, description, category)
 163 texinfo_documents = [
 164     (master_doc, 'VisEditor', u'Vis Editor Documentation',
 165      author, 'VisEditor', 'One line description of project.',
 166      'Miscellaneous'),
 167 ]
 168
 169 if not on_rtd:  # only import and set the theme if we're building docs locally
 170     import sphinx_rtd_theme
 171     html_theme = 'sphinx_rtd_theme'
 172     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 173
 174 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
 175