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 = 'Vis Editor'
  62 copyright = '2017, Marc André Tanner'
  63 author = '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 = '0.6'
  71 # The full version, including alpha/beta/rc tags.
  72 release = '0.6'
  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 primary_domain = 'c'
  90 highlight_language = 'c'
  91
  92 # If true, `todo` and `todoList` produce output, else they produce nothing.
  93 todo_include_todos = False
  94
  95 default_role = "any"
  96
  97 # -- Options for HTML output ----------------------------------------------
  98
  99 # The theme to use for HTML and HTML Help pages.  See the documentation for
 100 # a list of builtin themes.
 101 #
 102 # html_theme = 'alabaster'
 103
 104 # Theme options are theme-specific and customize the look and feel of a theme
 105 # further.  For a list of options available for each theme, see the
 106 # documentation.
 107 #
 108 # html_theme_options = {}
 109
 110 # Add any paths that contain custom static files (such as style sheets) here,
 111 # relative to this directory. They are copied after the builtin static files,
 112 # so a file named "default.css" will overwrite the builtin "default.css".
 113 html_static_path = ['_static']
 114
 115
 116 # -- Options for HTMLHelp output ------------------------------------------
 117
 118 # Output file base name for HTML help builder.
 119 htmlhelp_basename = 'VisEditordoc'
 120
 121
 122 # -- Options for LaTeX output ---------------------------------------------
 123
 124 latex_elements = {
 125     # The paper size ('letterpaper' or 'a4paper').
 126     #
 127     # 'papersize': 'letterpaper',
 128
 129     # The font size ('10pt', '11pt' or '12pt').
 130     #
 131     # 'pointsize': '10pt',
 132
 133     # Additional stuff for the LaTeX preamble.
 134     #
 135     # 'preamble': '',
 136
 137     # Latex figure (float) alignment
 138     #
 139     # 'figure_align': 'htbp',
 140 }
 141
 142 # Grouping the document tree into LaTeX files. List of tuples
 143 # (source start file, target name, title,
 144 #  author, documentclass [howto, manual, or own class]).
 145 latex_documents = [
 146     (master_doc, 'VisEditor.tex', 'Vis Editor Documentation',
 147      'Marc André Tanner', 'manual'),
 148 ]
 149
 150
 151 # -- Options for manual page output ---------------------------------------
 152
 153 # One entry per manual page. List of tuples
 154 # (source start file, name, description, authors, manual section).
 155 man_pages = [
 156     (master_doc, 'viseditor', 'Vis Editor Documentation',
 157      [author], 1)
 158 ]
 159
 160
 161 # -- Options for Texinfo output -------------------------------------------
 162
 163 # Grouping the document tree into Texinfo files. List of tuples
 164 # (source start file, target name, title, author,
 165 #  dir menu entry, description, category)
 166 texinfo_documents = [
 167     (master_doc, 'VisEditor', 'Vis Editor Documentation',
 168      author, 'VisEditor', 'One line description of project.',
 169      'Miscellaneous'),
 170 ]
 171
 172 if not on_rtd:  # only import and set the theme if we're building docs locally
 173     import sphinx_rtd_theme
 174     html_theme = 'sphinx_rtd_theme'
 175     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 176
 177 # otherwise, readthedocs.org uses their theme by default, so no need to specify it
 178