SPHINXOPTS =

SPHINXBUILD = sphinx-build

PAPER =

BUILDDIR = _build

PAPEROPT_a4 = -D latex_paper_size=a4

PAPEROPT_letter = -D latex_paper_size=letter

ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

html:

$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

@echo

@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

help:

@echo "Please use \`make <target>' where <target> is one of"

@echo " html to make standalone HTML files"

@echo " dirhtml to make HTML files named index.html in directories"

@echo " singlehtml to make a single large HTML file"

@echo " pickle to make pickle files"

@echo " json to make JSON files"

@echo " htmlhelp to make HTML files and a HTML help project"

@echo " qthelp to make HTML files and a qthelp project"

@echo " devhelp to make HTML files and a Devhelp project"

@echo " epub to make an epub"

@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"

@echo " latexpdf to make LaTeX files and run them through pdflatex"

@echo " text to make text files"

@echo " man to make manual pages"

@echo " texinfo to make Texinfo files"

@echo " info to make Texinfo files and run them through makeinfo"

@echo " gettext to make PO message catalogs"

@echo " changes to make an overview of all changed/added/deprecated items"

@echo " linkcheck to check all external links for integrity"

@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:

-rm -rf $(BUILDDIR)/*

dirhtml:

$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml

@echo

@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:

$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml

@echo

@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:

$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle

@echo

@echo "Build finished; now you can process the pickle files."

json:

$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json

@echo

@echo "Build finished; now you can process the JSON files."

htmlhelp:

$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp

@echo

@echo "Build finished; now you can run HTML Help Workshop with the" \

".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:

$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp

@echo

@echo "Build finished; now you can run "qcollectiongenerator" with the" \

".qhcp project file in $(BUILDDIR)/qthelp, like this:"

@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-opc.qhcp"

@echo "To view the help file:"

@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-opc.qhc"

devhelp:

$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp

@echo

@echo "Build finished."

@echo "To view the help file:"

@echo "# mkdir -p $$HOME/.local/share/devhelp/python-opc"

@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-opc"

@echo "# devhelp"

epub:

$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub

@echo

@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:

$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

@echo

@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."

@echo "Run \`make' in that directory to run these through (pdf)latex" \

"(use \`make latexpdf' here to do that automatically)."

latexpdf:

$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex

@echo "Running LaTeX files through pdflatex..."

$(MAKE) -C $(BUILDDIR)/latex all-pdf

@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:

$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text

@echo

@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:

$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man

@echo

@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:

$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

@echo

@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."

@echo "Run \`make' in that directory to run these through makeinfo" \

"(use \`make info' here to do that automatically)."

info:

$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo

@echo "Running Texinfo files through makeinfo..."

make -C $(BUILDDIR)/texinfo info

@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:

$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale

@echo

@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:

$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes

@echo

@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:

$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck

@echo

@echo "Link check complete; look for any errors in the above output " \

"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:

$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest

@echo "Testing of doctests in the sources finished, look at the " \

"results in $(BUILDDIR)/doctest/output.txt."

Copyright (c) 2011 Bay Citizen & Texas Tribune

Original ReadTheDocs.org code

Copyright (c) 2010 Charles Leifer, Eric Holscher, Bobby Grace

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.

{% extends "basic/layout.html" %}

{% set script_files = script_files + [pathto("_static/searchtools.js", 1)] %}

{% block htmltitle %}

{{ super() }}

<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;"/>

{% endblock %}

{% block footer %}

<div class="footer">

{%- if show_copyright %}

{%- if hasdoc('copyright') %}

{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}

{%- else %}

{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}

{%- endif %}

{%- endif %}

{%- if last_updated %}

{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}

{%- endif %}

{%- if show_sphinx %}

{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}

{%- endif %}

{%- if theme_show_rtd %}

{% trans %}<br />Theme based on <a href="http://readthedocs.org/">Read The Docs</a>{% endtrans %}

{% endif %}

{% if theme_analytics_code %}

<script type="text/javascript">

var _gaq = _gaq || [];

_gaq.push(['_setAccount', '{{ theme_analytics_code }}']);

_gaq.push(['_trackPageview']);

(function() {

var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

})();

{% endif %}

{% endblock %}

[theme]

inherit = default

stylesheet = rtd.css

pygment_style = default

show_sphinx = False

[options]

show_rtd = True

white = #ffffff

almost_white = #f8f8f8

barely_white = #f2f2f2

dirty_white = #eeeeee

almost_dirty_white = #e6e6e6

dirtier_white = #dddddd

lighter_gray = #cccccc

gray_a = #aaaaaa

gray_9 = #999999

light_gray = #888888

gray_7 = #777777

gray = #666666

dark_gray = #444444

gray_2 = #222222

black = #111111

light_color = #e8ecef

light_medium_color = #DDEAF0

medium_color = #8ca1af

medium_color_link = #86989b

medium_color_link_hover = #a6b8bb

dark_color = #465158

h1 = #000000

h2 = #465158

h3 = #6c818f

link_color = #444444

link_color_decoration = #CCCCCC

medium_color_hover = #697983

green_highlight = #8ecc4c

positive_dark = #609060

positive_medium = #70a070

positive_light = #e9ffe9

negative_dark = #900000

negative_medium = #b04040

negative_light = #ffe9e9

negative_text = #c60f0f

ruler = #abc

viewcode_bg = #f4debf

viewcode_border = #ac9

highlight = #ffe080

code_background = #eeeeee

background = #465158

background_link = #ffffff

background_link_half = #ffffff

background_text = #eeeeee

background_text_link = #86989b