From: Roger Shimizu Date: Sun, 19 Jun 2016 14:31:43 +0900 Subject: Revert "Remove old Sphinx documentation template" This reverts commit 7461f6ebbcd6961c617d03a277760f6e5488d2e7. --- docs/_static/.keep | 0 docs/_static/docco-sphinx.css | 300 ++++++++++++++++++++++++++++++++++++++++++ docs/_static/pygments.css | 61 +++++++++ docs/_templates/.keep | 1 + docs/conf.py | 80 +++++++++++ docs/index.rst | 22 ++++ 6 files changed, 464 insertions(+) create mode 100644 docs/_static/.keep create mode 100644 docs/_static/docco-sphinx.css create mode 100644 docs/_static/pygments.css create mode 100644 docs/_templates/.keep create mode 100644 docs/conf.py create mode 100644 docs/index.rst diff --git a/docs/_static/.keep b/docs/_static/.keep new file mode 100644 index 0000000..e69de29 diff --git a/docs/_static/docco-sphinx.css b/docs/_static/docco-sphinx.css new file mode 100644 index 0000000..312d148 --- /dev/null +++ b/docs/_static/docco-sphinx.css @@ -0,0 +1,300 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'Palatino Linotype', Palatino, 'URW Palladio L', 'Book Antiqua', FreeSerif, serif; + /*font-size: 95%;*/ + font-size: 95%; + color: #252519; + margin: 0; + padding: 0; +} + +div.document { +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 19em; + background-color: #ffffff; +} + +div.body { + color: #252519; + padding: 30px 0px 30px 60px; + width: 40em; +} + +div.footer { + width: 100%; + padding: 9px 0 9px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #261a3b; + text-decoration: underline; +} + +div.related { + background-color: #eee; + border: 1px solid #ccc; + line-height: 30px; +} + +div.related a { + color: #261a3b; +} + +div.sphinxsidebar { + padding: 30px 0px 0 20px; + width: 19em; + color: #555; +} + +div.sphinxsidebar a { + color: #555; +} + +div.sphinxsidebar h3 { + font-size: 1.4em; + margin: 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 1.3em; + margin: 5px 0 0 0; + padding: 0; +} + +div.sphinxsidebar p { +} + +div.sphinxsidebar p.topless { + margin: 5px 10px 10px 10px; +} + +div.sphinxsidebar ul { + margin: 10px; + padding: 0; + color: #ffffff; +} + +div.sphinxsidebar li { + padding-top: 5px; + line-height: 115%; +} + +div.sphinxsidebar input { + border: 1px solid #ccc; + font-family: sans-serif; + font-size: 1em; +} + + + +/* -- hyperlink styles ------------------------------------------------------ */ + +a { + color: #306060; + text-decoration: none; +} + +a:visited { + color: #306060; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + + + +/* -- body styles ----------------------------------------------------------- */ + +div.body h1, +div.body h2 { + border-top: 1px solid #ccc; + margin: 40px -20px 10px -20px; + padding: 3px 0 3px 0; +} + +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + margin: 20px 0px -10px 0px; +} + +div.body h1 { margin-top: 0; font-size: 200%; border: 0px; } +div.body h2 { font-size: 160%; } +div.body h3 { font-size: 140%; } +div.body h4 { font-size: 120%; } +div.body h5 { font-size: 110%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #c60f0f; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #c60f0f; + color: white; +} + +div.body p, div.body dd, div.body li { + line-height: 130%; +} + +p.admonition-title { + margin-right: 0.3em; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.admonition p { + margin-bottom: 5px; +} + +div.admonition pre { + margin-bottom: 5px; +} + +div.admonition ul, div.admonition ol { + margin-bottom: 5px; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace; + font-size: 80%; + padding: 5px; + background-color: #f5f5ff; + color: #333333; + line-height: 130%; + border: 1px solid #e5e5ee; + border-left: none; + border-right: none; +} + +tt { + font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace; + background-color: #f8f8ff; + border: 1px solid #dedede; + padding: 0 0.2em; + font-size: 85%; +} + +a tt { + background-color: transparent; + border: 0px; +} + +dt { + font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace; + font-size: 90%; + line-height: 130%; +} + +table.indextable dt { + font-family: 'Palatino Linotype', Palatino, 'URW Palladio L', 'Book Antiqua', FreeSerif, serif; + font-size: 100%; +} + +em.property { + font-size: 90%; +} + +tt.descclassname { + background-color: transparent; + border: 0px; + padding: 0px; +} + +tt.descname { + background-color: transparent; + border: 0px; + font-size: 100%; + padding: 0px; +} + +dt big { + font-family: 'Palatino Linotype', Palatino, 'URW Palladio L', 'Book Antiqua', FreeSerif, serif; + font-size: 140%; + padding: 0 2px; +} + +dt big.param_start_brace { + padding: 0 6px; +} + +dt big.param_end_brace { + padding: 0 6px; +} + +dt span.optional { + font-family: 'Palatino Linotype', Palatino, 'URW Palladio L', 'Book Antiqua', FreeSerif, serif; + font-size: 140%; + padding: 0 2px; +} + +th { + background-color: #ede; +} + +.warning tt { + background: #efc2c2; +} + +.note tt { + background: #d6d6d6; +} + +.viewcode-back { + font-family: sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} diff --git a/docs/_static/pygments.css b/docs/_static/pygments.css new file mode 100644 index 0000000..fa06454 --- /dev/null +++ b/docs/_static/pygments.css @@ -0,0 +1,61 @@ +.highlight .hll { background-color: #ffffcc } +.highlight .c { color: #408080; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #FF0000 } /* Error */ +.highlight .k { color: #954121 } /* Keyword */ +.highlight .o { color: #666666 } /* Operator */ +.highlight .cm { color: #408080; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #BC7A00 } /* Comment.Preproc */ +.highlight .c1 { color: #408080; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #408080; font-style: italic } /* Comment.Special */ +.highlight .gd { color: #A00000 } /* Generic.Deleted */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gr { color: #FF0000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #00A000 } /* Generic.Inserted */ +.highlight .go { color: #808080 } /* Generic.Output */ +.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ +.highlight .gt { color: #0040D0 } /* Generic.Traceback */ +.highlight .kc { color: #954121 } /* Keyword.Constant */ +.highlight .kd { color: #954121; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #954121; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #954121 } /* Keyword.Pseudo */ +.highlight .kr { color: #954121; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666666 } /* Literal.Number */ +.highlight .s { color: #219161 } /* Literal.String */ +.highlight .na { color: #7D9029 } /* Name.Attribute */ +.highlight .nb { color: #954121 } /* Name.Builtin */ +.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */ +.highlight .no { color: #880000 } /* Name.Constant */ +.highlight .nd { color: #AA22FF } /* Name.Decorator */ +.highlight .ni { color: #999999; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #D2413A; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #0000FF } /* Name.Function */ +.highlight .nl { color: #A0A000 } /* Name.Label */ +.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #954121; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19469D } /* Name.Variable */ +.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #bbbbbb } /* Text.Whitespace */ +.highlight .mf { color: #666666 } /* Literal.Number.Float */ +.highlight .mh { color: #666666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666666 } /* Literal.Number.Oct */ +.highlight .sb { color: #219161 } /* Literal.String.Backtick */ +.highlight .sc { color: #219161 } /* Literal.String.Char */ +.highlight .sd { color: #219161; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #219161 } /* Literal.String.Double */ +.highlight .se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #219161 } /* Literal.String.Heredoc */ +.highlight .si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #954121 } /* Literal.String.Other */ +.highlight .sr { color: #BB6688 } /* Literal.String.Regex */ +.highlight .s1 { color: #219161 } /* Literal.String.Single */ +.highlight .ss { color: #19469D } /* Literal.String.Symbol */ +.highlight .bp { color: #954121 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #19469D } /* Name.Variable.Class */ +.highlight .vg { color: #19469D } /* Name.Variable.Global */ +.highlight .vi { color: #19469D } /* Name.Variable.Instance */ +.highlight .il { color: #666666 } /* Literal.Number.Integer.Long */ diff --git a/docs/_templates/.keep b/docs/_templates/.keep new file mode 100644 index 0000000..0519ecb --- /dev/null +++ b/docs/_templates/.keep @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..22fb9c1 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,80 @@ +# -*- coding: utf-8 -*- + +import sys, os + +extensions = [] +source_suffix = '.rst' +master_doc = 'index' +project_name = u'APPNAME' +project_slug = u'appname' +company = u'COMPANY' +copyright_years = u'2012' + +default_role = 'c:func' +primary_domain = 'c' + +rst_epilog = """ +.. |project_name| replace:: """ + project_name + """ +""" + +# Intersphinx stuff + +# If your documentation uses intersphinx to link to other Sphinx +# documentation sets, uncomment and fill in the following. +# +#intersphinx_mapping = { +# 'libcork': ('http://libcork.readthedocs.org/en/latest/', None), +#} + +# Our CMake build scripts will insert overrides below if the prereq +# libraries have installed their Sphinx documentation locally. DO NOT +# uncomment out the last line of this block; we need it commented so +# that this conf.py file still works if CMake doesn't do its +# substitution thing. +# @INTERSPHINX_OVERRIDES@ + +#---------------------------------------------------------------------- +# Everything below here shouldn't need to be changed. + +release = None +version = None + +# Give CMake a chance to insert a version number +# @VERSION_FOR_CONF_PY@ + +# Otherwise grab version from git +if version is None: + import re + import subprocess + release = str(subprocess.check_output(["git", "describe"]).rstrip()) + version = re.sub(r"-dev.*$", "-dev", release) + +# Project details + +project = project_name +copyright = copyright_years+u', '+company +templates_path = ['_templates'] +exclude_patterns = ['_build'] +pygments_style = 'sphinx' + +html_theme = 'default' +html_style = 'docco-sphinx.css' +html_static_path = ['_static'] +htmlhelp_basename = project_slug+'-doc' + + +latex_documents = [ + ('index', project_slug+'.tex', project_name+u' Documentation', + company, 'manual'), +] + +man_pages = [ + ('index', project_slug, project_name+u' Documentation', + [company], 1) +] + +texinfo_documents = [ + ('index', project_slug, project_name+u' Documentation', + company, project_name, 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7390b16 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,22 @@ +.. _index: + +|project_name| documentation +============================ + +This is the documentation for |project_name| |release|, last updated +|today|. + + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`search`