conf.py

# -*- coding: utf-8 -*-
#
# Open SoC Debug documentation build configuration file
#
# This file is execfile()d with the current directory set to its
# containing dir.

import sys
import os
import subprocess
import re
from datetime import datetime

# Add in-tree extensions to path
sys.path.insert(0, os.path.abspath('../sphinx'))

# Check if we run in one of the CI build environments
# Read The Docs
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
# Travis
travis_build = os.environ.get('TRAVIS_CI', None) == 'True'

# -- General configuration ------------------------------------------------

# Minimum Sphinx version we require
needs_sphinx = '1.4.5'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
  'breathe',
  'rstFlatTable',
  'sphinx.ext.todo',
  'sphinx.ext.autodoc',
  'sphinx.ext.mathjax',
  'cairosvgconverter',
]

# 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:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Open SoC Debug'
copyright = u'2016-%d, The Open SoC Debug Contributors' % datetime.now().year
author = u'The Open SoC Debug Contributors'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'0.1'
# The full version, including alpha/beta/rc tags.
release = u'0.1'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'

# 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 = [ ]

# 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 = True

# Number figures
numfig = True


# -- Options for HTML output ----------------------------------------------

# The Read the Docs theme is available from
# https://github.com/snide/sphinx_rtd_theme
#
# Install with
# - pip install sphinx_rtd_theme
# or
# - apt-get install python-sphinx-rtd-theme

try:
    import sphinx_rtd_theme
    html_theme = 'sphinx_rtd_theme'
except ImportError:
    sys.stderr.write('Warning: The Sphinx \'sphinx_rtd_theme\' HTML theme was '+
        'not found. Make sure you have the theme installed to produce pretty '+
        'HTML output. Falling back to the default theme.\n')

    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
# documentation.
#
# html_theme_options = {}

# 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 = ['_static']

html_show_sourcelink = False


# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'OpenSoCDebugdoc'


# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    'papersize': 'a4paper',

    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',

    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
#  author, documentclass [howto, manual, or own class]).
latex_documents = []
if not read_the_docs_build:
    latex_documents += [
        ('01_overview/index', 'osd-overview.tex', u'Open SoC Debug Overview',
         u'The Open SoC Debug Contributors', 'manual'),

        ('02_spec/index', 'osd-spec.tex', u'Open SoC Debug Specification',
         u'The Open SoC Debug Contributors', 'manual'),

        ('03_user/index', 'osd-userguide.tex', u'Open SoC Debug User Guides',
         u'The Open SoC Debug Contributors', 'manual'),

        ('04_implementer/index', 'osd-implementerguide.tex',
         u'Open SoC Debug Implementer Guides',
         u'The Open SoC Debug Contributors', 'manual'),
    ]

# ReadTheDocs only supports a single PDF document, make the combined doc
# available.
latex_documents += [
    (master_doc, 'opensocdebug.tex',
     u'Open SoC Debug Documentation Library',
     u'The Open SoC Debug Contributors', 'manual'),
]

latex_toplevel_sectioning = 'chapter'

# show URLs in a footnote to make them available in printed documents
latex_show_urls = 'footnote'

latex_domain_indices = False

latex_keep_old_macro_names = False


# -- 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, 'opensocdebug', u'Open SoC Debug Documentation',
     [author], 1)
]


# -- 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, 'OpenSoCDebug', u'Open SoC Debug Documentation',
     author, 'OpenSoCDebug', 'One line description of project.',
     'Miscellaneous'),
]

# -- Options for Breathe input (inclusion of Doxygen-generated API docs) --
#breathe_projects = { }
#breathe_default_project = ""


primary_domain = 'c'
highlight_language = 'guess'



# -- Sphinx customizations -----------------------------------------------
# We customize things here instead of in a separate script, because the changes
# here are also applied when running on Read The Docs.


def setup(app):
    # override wide tables in RTD theme
    app.add_stylesheet("theme_overrides.css")