bootstrap-vz/docs/conf.py

# -*- coding: utf-8 -*-
#
# bootstrap-vz documentation build configuration file, created by
# sphinx-quickstart on Sun Mar 23 16:17:28 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# 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(os.pardir))

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

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = ['sphinx.ext.coverage',
              'sphinx.ext.autodoc',
              'sphinx.ext.linkcode',
              'docs.transform_github_links',
              ]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'bootstrap-vz'
copyright = u'2014, Anders Ingemann'

# 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.
#
from bootstrapvz import __version__
# The short X.Y version.
version = '.'.join(__version__.split('.')[:2])
# The full version, including alpha/beta/rc tags.
release = __version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
show_authors = True

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False


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

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.

# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'

if not on_rtd:  # only import and set the theme if we're building docs locally
	import sphinx_rtd_theme
	html_theme = 'sphinx_rtd_theme'
	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# 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 themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None

# 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']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
#html_domain_indices = True

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
#html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'bootstrap-vzdoc'


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

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

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

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

# 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 = [('index', 'bootstrap-vz.tex', u'bootstrap-vz Documentation',
                    u'Anders Ingemann', 'manual'),
                   ]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'bootstrap-vz', u'bootstrap-vz Documentation', [u'Anders Ingemann'], 1)]

# If true, show URL addresses after external links.
#man_show_urls = False


# -- 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 = [('index', 'bootstrap-vz', u'bootstrap-vz Documentation',
                      u'Anders Ingemann', 'bootstrap-vz', 'One line description of project.',
                      'Miscellaneous'),
                     ]

# Documents to append as an appendix to all manuals.
#texinfo_appendices = []

# If false, no module index is generated.
#texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False


# -- Link to rst files scattered throughout the project -------------------

import glob
import os.path

for readme_path in glob.glob('../bootstrapvz/providers/*/README.rst'):
	provider_name = os.path.basename(os.path.dirname(readme_path))
	include_path = os.path.join('providers', provider_name + '.rst')
	if not os.path.exists(include_path):
		path_to_readme = os.path.join('../../bootstrapvz/providers', provider_name, 'README.rst')
		with open(include_path, 'w') as include:
			include.write('.. include:: ' + path_to_readme)


for readme_path in glob.glob('../bootstrapvz/plugins/*/README.rst'):
	plugin_name = os.path.basename(os.path.dirname(readme_path))
	include_path = os.path.join('plugins', plugin_name + '.rst')
	if not os.path.exists(include_path):
		path_to_readme = os.path.join('../../bootstrapvz/plugins', plugin_name, 'README.rst')
		with open(include_path, 'w') as include:
			include.write('.. include:: ' + path_to_readme)


# -- Create task overview graph data --------------------------------------

from docs import taskoverview

data = taskoverview.generate_graph_data()
taskoverview.write_data(data, '_static/graph.json')


# -- Substitute links for github with relative links in readthedocs -------


if on_rtd:
	pass

# Snatched from here:
# https://sourcegraph.com/github.com/Gallopsled/pwntools@master/.PipPackage/pwntools/.def/docs/source/conf/linkcode_resolve/lines
baseurl = 'https://github.com/andsens/bootstrap-vz'

import subprocess
try:
	git_head = subprocess.check_output('git describe --tags 2>/dev/null', shell=True)
except subprocess.CalledProcessError:
	try:
		git_head = subprocess.check_output('git rev-parse HEAD', shell=True).strip()[:10]
	except subprocess.CalledProcessError:
		pass


def linkcode_resolve(domain, info):
	if domain != 'py':
		return None
	if not info['module']:
		return None

	filepath = info['module'].replace('.', '/') + '.py'
	fmt_args = {'baseurl': baseurl,
	            'commit': git_head,
	            'path': filepath}

	import importlib
	import inspect
	import types
	module = importlib.import_module(info['module'])
	value = module
	for part in info['fullname'].split('.'):
		value = getattr(value, part, None)
		if value is None:
			break
	valid_types = (types.ModuleType, types.ClassType, types.MethodType,
	               types.FunctionType, types.TracebackType,
	               types.FrameType, types.CodeType)
	if isinstance(value, valid_types):
		try:
			lines, first = inspect.getsourcelines(value)
			fmt_args['linestart'] = first
			fmt_args['lineend'] = first + len(lines) - 1
			return '{baseurl}/blob/{commit}/{path}#L{linestart}-L{lineend}'.format(**fmt_args)
		except IOError:
			pass
	return '{baseurl}/blob/{commit}/{path}'.format(**fmt_args)