Skip to content

Commit 0251005

Browse files
yashhyashh
committed
moving along the docs
1 parent 0f414c4 commit 0251005

22 files changed

+1453
-1
lines changed

‎docs/source/_theme/ADCTheme/README.rst

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
==============
2+
How To Install
3+
==============
4+
5+
Install in Sphinx
6+
-----------------
7+
8+
Copy this directory into the ``sphinx/templates`` directory where Shpinx is installed. For example, a standard install of sphinx on Mac OS X is at ``/Library/Python/2.6/site-packages/Sphinx-0.6.3-py2.6.egg/``
9+
10+
Install Somewhere Else
11+
----------------------
12+
13+
If you want to install this theme somewhere else, you will have to modify the ``conf.py`` file. ::
14+
15+
templates_path = ['/absolute/path/to/dir/','relative/path/']
16+
17+
Making Sphinx Use the Theme
18+
---------------------------
19+
20+
Edit the ``conf.py`` file and make the following setting: ::
21+
22+
html_theme = 'ADCtheme'
23+
24+
Screen Shots
25+
------------
26+
27+
.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn1.png
28+
29+
.. image:: http://github.com/coordt/ADCtheme/raw/master/static/scrn2.png
30+
31+
To Do
32+
-----
33+
34+
* Gotta get the javascript working so the Table of Contents is hide-able.
35+
* Probably lots of css cleanup.

‎docs/source/_theme/ADCTheme/layout.html

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
{% extends "basic/layout.html" %}
2+
{%- block doctype -%}
3+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5+
{%- endblock %}
6+
{%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
7+
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
8+
{%- block linktags %}
9+
{%- if hasdoc('about') %}
10+
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
11+
{%- endif %}
12+
{%- if hasdoc('genindex') %}
13+
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
14+
{%- endif %}
15+
{%- if hasdoc('search') %}
16+
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
17+
{%- endif %}
18+
{%- if hasdoc('copyright') %}
19+
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
20+
{%- endif %}
21+
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
22+
{%- if parents %}
23+
<link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" />
24+
{%- endif %}
25+
{%- if next %}
26+
<link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" />
27+
{%- endif %}
28+
{%- if prev %}
29+
<link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" />
30+
{%- endif %}
31+
{%- endblock %}
32+
{%- block extrahead %} {% endblock %}
33+
{%- block header %}{% endblock %}
34+
{%- block relbar1 %}
35+
<div id="docstitle">
36+
<p>{{docstitle}}</p>
37+
</div>
38+
<div id="header">
39+
<div id="title"><h1>{{ title|striptags }}</h1></div>
40+
<ul id="headerButtons">
41+
<li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
42+
<li id="page_buttons">
43+
{%- for rellink in rellinks %}
44+
<div class="headerButton"><a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}" {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a></div>
45+
{%- endfor %}
46+
</li>
47+
</ul>
48+
</div>
49+
{% endblock %}
50+
51+
{%- block sidebar1 %}
52+
{%- if not embedded %}{% if not theme_nosidebar|tobool %}
53+
<div id="sphinxsidebar">
54+
<div class="sphinxsidebarwrapper">
55+
{%- block sidebarlogo %}
56+
{%- if logo %}
57+
<p class="logo"><a href="{{ pathto(master_doc) }}">
58+
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
59+
</a></p>
60+
{%- endif %}
61+
{%- endblock %}
62+
{%- block sidebartoc %}
63+
<ul><li class="toctree-l1"><a href="{{ pathto(master_doc) }}">{{ _('Main Page') }}</a></li></ul>
64+
{{ toctree() }}
65+
{%- endblock %}
66+
{%- block sidebarrel %}
67+
{%- endblock %}
68+
{%- block sidebarsourcelink %}
69+
{%- if show_source and has_source and sourcename %}
70+
<h3>{{ _('This Page') }}</h3>
71+
<ul class="this-page-menu">
72+
<li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
73+
rel="nofollow">{{ _('Show Source') }}</a></li>
74+
</ul>
75+
{%- endif %}
76+
{%- endblock %}
77+
{%- if customsidebar %}
78+
{% include customsidebar %}
79+
{%- endif %}
80+
{%- block sidebarsearch %}
81+
{%- if pagename != "search" %}
82+
<div id="searchbox" style="display: none">
83+
{# <h3>{{ _('Quick search') }}</h3> #}
84+
<form class="search" action="{{ pathto('search') }}" method="get">
85+
<div class="search-wrapper">
86+
<span class="search-left"></span>
87+
<input class="prettysearch" type="text" name="q" size="18" />
88+
<span class="search-right">&nbsp;</span>
89+
</div>
90+
<input type="submit" value="{{ _('Search') }}" class="searchbutton" />
91+
<input type="hidden" name="check_keywords" value="yes" />
92+
<input type="hidden" name="area" value="default" />
93+
</form>
94+
<p class="searchtip" style="font-size: 90%">
95+
{{ _('Enter search terms or a module, class or function name.') }}
96+
</p>
97+
</div>
98+
<script type="text/javascript">$('#searchbox').show(0);</script>
99+
{%- endif %}
100+
{%- endblock %}
101+
</div>
102+
</div>
103+
{%- endif %}{% endif %}
104+
105+
{% endblock %}
106+
{%- block document %}
107+
<div class="documentwrapper">
108+
{%- if not embedded %}{% if not theme_nosidebar|tobool %}
109+
<div class="bodywrapper">
110+
{%- endif %}{% endif %}
111+
<div class="body">
112+
{% block body %} {% endblock %}
113+
</div>
114+
{%- if not embedded %}{% if not theme_nosidebar|tobool %}
115+
</div>
116+
{%- endif %}{% endif %}
117+
</div>
118+
<div class="footer">
119+
<p>{%- if hasdoc('copyright') %}
120+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
121+
{%- else %}
122+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
123+
{%- endif %}
124+
{%- if last_updated %}
125+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
126+
{%- endif %}
127+
{%- if show_sphinx %}
128+
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
129+
{%- endif %}
130+
</p>
131+
</div>
132+
{%- endblock %}
133+
{%- block sidebar2 %}{% endblock %}
134+
{%- block relbar2 %}{% endblock %}
135+
{%- block footer %}
136+
<div id="breadcrumbs">
137+
{%- for parent in parents %}
138+
<a href="{{ parent.link|e }}" {{ accesskey("U") }}>{{ parent.title }}</a><img src="triangle_closed.png" alt="Right arrow">
139+
{%- endfor %}
140+
<a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>
141+
</ul>
142+
</div>
143+
{%- endblock %}

0 commit comments

Comments
 (0)