Commit 9bd09831 authored by Marcel Rieger's avatar Marcel Rieger
Browse files

Rename doc -> docs, add readthedocs sphinx theme.

parent ebbad9d5
......@@ -22,8 +22,8 @@ MANIFEST
hg-check*
vispa.egg*
*.*~
doc/source/js
doc/source/py
docs/source/js
docs/source/py
*.sublime-workspace
.vagrant
vagrant_ansible_inventory_default
......
......@@ -98,25 +98,30 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
print "\n\n"
print os.getcwd()
print "\n\n"
html_theme = 'sphinx_rtd_theme'
# 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 = {
"relbarbgcolor": "rgb(34, 34, 34)",
"sidebarbgcolor": "rgb(242, 242, 242)",
"sidebartextcolor": "rgb(51, 51, 51)",
"sidebarlinkcolor": "rgb(0, 107, 214)",
"footerbgcolor": "white",
"footertextcolor": "black",
"linkcolor": "rgb(0, 107, 214)",
"visitedlinkcolor": "rgb(0, 62, 124)",
"headtextcolor": "rgb(51, 51, 51)",
# "relbarbgcolor": "rgb(34, 34, 34)",
# "sidebarbgcolor": "rgb(242, 242, 242)",
# "sidebartextcolor": "rgb(51, 51, 51)",
# "sidebarlinkcolor": "rgb(0, 107, 214)",
# "footerbgcolor": "white",
# "footertextcolor": "black",
# "linkcolor": "rgb(0, 107, 214)",
# "visitedlinkcolor": "rgb(0, 62, 124)",
# "headtextcolor": "rgb(51, 51, 51)",
}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = [
"../themes"
]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
......
"""Sphinx ReadTheDocs theme.
From https://github.com/ryan-roemer/sphinx-bootstrap-theme.
"""
import os
VERSION = (0, 1, 5)
__version__ = ".".join(str(v) for v in VERSION)
__version_full__ = __version__
def get_html_theme_path():
"""Return list of HTML theme paths."""
cur_dir = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
return cur_dir
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="{{ pathto(master_doc) }}">Docs</a> &raquo;</li>
{% for doc in parents %}
<li><a href="{{ doc.link|e }}">{{ doc.title }}</a> &raquo;</li>
{% endfor %}
<li>{{ title }}</li>
<li class="wy-breadcrumbs-aside">
{% if display_github %}
<a href="https://github.com/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-github"> Edit on GitHub</a>
{% elif display_bitbucket %}
<a href="https://bitbucket.org/{{ bitbucket_user }}/{{ bitbucket_repo }}/src/{{ bitbucket_version}}{{ conf_py_path }}{{ pagename }}{{ source_suffix }}" class="fa fa-bitbucket"> Edit on Bitbucket</a>
{% elif show_source and has_source and sourcename %}
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> View page source</a>
{% endif %}
</li>
</ul>
<hr/>
</div>
<footer>
{% if next or prev %}
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
{% if next %}
<a href="{{ next.link|e }}" class="btn btn-neutral float-right" title="{{ next.title|striptags|e }}">Next <span class="fa fa-arrow-circle-right"></span></a>
{% endif %}
{% if prev %}
<a href="{{ prev.link|e }}" class="btn btn-neutral" title="{{ prev.title|striptags|e }}"><span class="fa fa-arrow-circle-left"></span> Previous</a>
{% endif %}
</div>
{% endif %}
<hr/>
<div role="contentinfo">
<p>
{%- 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 %}
</p>
</div>
{% trans %}Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>{% endtrans %}.
</footer>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment