Skip to content

Commit d6c2eaf

Browse files
author
Matt George
committed
Merge remote branch 'yashh/master'
2 parents e03d110 + d972d30 commit d6c2eaf

32 files changed

+2005
-0
lines changed

‎docs/Makefile

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
9+
# Internal variables.
10+
PAPEROPT_a4 = -D latex_paper_size=a4
11+
PAPEROPT_letter = -D latex_paper_size=letter
12+
ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
13+
14+
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
15+
16+
help:
17+
@echo "Please use \`make <target>' where <target> is one of"
18+
@echo " html to make standalone HTML files"
19+
@echo " dirhtml to make HTML files named index.html in directories"
20+
@echo " pickle to make pickle files"
21+
@echo " json to make JSON files"
22+
@echo " htmlhelp to make HTML files and a HTML help project"
23+
@echo " qthelp to make HTML files and a qthelp project"
24+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
25+
@echo " changes to make an overview of all changed/added/deprecated items"
26+
@echo " linkcheck to check all external links for integrity"
27+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
28+
29+
clean:
30+
-rm -rf build/*
31+
32+
html:
33+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
34+
@echo
35+
@echo "Build finished. The HTML pages are in build/html."
36+
37+
dirhtml:
38+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
39+
@echo
40+
@echo "Build finished. The HTML pages are in build/dirhtml."
41+
42+
pickle:
43+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
44+
@echo
45+
@echo "Build finished; now you can process the pickle files."
46+
47+
json:
48+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
49+
@echo
50+
@echo "Build finished; now you can process the JSON files."
51+
52+
htmlhelp:
53+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
54+
@echo
55+
@echo "Build finished; now you can run HTML Help Workshop with the" \
56+
".hhp project file in build/htmlhelp."
57+
58+
qthelp:
59+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
60+
@echo
61+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
62+
".qhcp project file in build/qthelp, like this:"
63+
@echo "# qcollectiongenerator build/qthelp/PyRes.qhcp"
64+
@echo "To view the help file:"
65+
@echo "# assistant -collectionFile build/qthelp/PyRes.qhc"
66+
67+
latex:
68+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
69+
@echo
70+
@echo "Build finished; the LaTeX files are in build/latex."
71+
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
72+
"run these through (pdf)latex."
73+
74+
changes:
75+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
76+
@echo
77+
@echo "The overview file is in build/changes."
78+
79+
linkcheck:
80+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
81+
@echo
82+
@echo "Link check complete; look for any errors in the above output " \
83+
"or in build/linkcheck/output.txt."
84+
85+
doctest:
86+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest
87+
@echo "Testing of doctests in the sources finished, look at the " \
88+
"results in build/doctest/output.txt."

‎docs/make.bat

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
@ECHO OFF
2+
3+
REM Command file for Sphinx documentation
4+
5+
set SPHINXBUILD=sphinx-build
6+
set ALLSPHINXOPTS=-d build/doctrees %SPHINXOPTS% source
7+
if NOT "%PAPER%" == "" (
8+
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
9+
)
10+
11+
if "%1" == "" goto help
12+
13+
if "%1" == "help" (
14+
:help
15+
echo.Please use `make ^<target^>` where ^<target^> is one of
16+
echo. html to make standalone HTML files
17+
echo. dirhtml to make HTML files named index.html in directories
18+
echo. pickle to make pickle files
19+
echo. json to make JSON files
20+
echo. htmlhelp to make HTML files and a HTML help project
21+
echo. qthelp to make HTML files and a qthelp project
22+
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
23+
echo. changes to make an overview over all changed/added/deprecated items
24+
echo. linkcheck to check all external links for integrity
25+
echo. doctest to run all doctests embedded in the documentation if enabled
26+
goto end
27+
)
28+
29+
if "%1" == "clean" (
30+
for /d %%i in (build\*) do rmdir /q /s %%i
31+
del /q /s build\*
32+
goto end
33+
)
34+
35+
if "%1" == "html" (
36+
%SPHINXBUILD% -b html %ALLSPHINXOPTS% build/html
37+
echo.
38+
echo.Build finished. The HTML pages are in build/html.
39+
goto end
40+
)
41+
42+
if "%1" == "dirhtml" (
43+
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% build/dirhtml
44+
echo.
45+
echo.Build finished. The HTML pages are in build/dirhtml.
46+
goto end
47+
)
48+
49+
if "%1" == "pickle" (
50+
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% build/pickle
51+
echo.
52+
echo.Build finished; now you can process the pickle files.
53+
goto end
54+
)
55+
56+
if "%1" == "json" (
57+
%SPHINXBUILD% -b json %ALLSPHINXOPTS% build/json
58+
echo.
59+
echo.Build finished; now you can process the JSON files.
60+
goto end
61+
)
62+
63+
if "%1" == "htmlhelp" (
64+
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% build/htmlhelp
65+
echo.
66+
echo.Build finished; now you can run HTML Help Workshop with the ^
67+
.hhp project file in build/htmlhelp.
68+
goto end
69+
)
70+
71+
if "%1" == "qthelp" (
72+
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% build/qthelp
73+
echo.
74+
echo.Build finished; now you can run "qcollectiongenerator" with the ^
75+
.qhcp project file in build/qthelp, like this:
76+
echo.^> qcollectiongenerator build\qthelp\PyRes.qhcp
77+
echo.To view the help file:
78+
echo.^> assistant -collectionFile build\qthelp\PyRes.ghc
79+
goto end
80+
)
81+
82+
if "%1" == "latex" (
83+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% build/latex
84+
echo.
85+
echo.Build finished; the LaTeX files are in build/latex.
86+
goto end
87+
)
88+
89+
if "%1" == "changes" (
90+
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% build/changes
91+
echo.
92+
echo.The overview file is in build/changes.
93+
goto end
94+
)
95+
96+
if "%1" == "linkcheck" (
97+
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% build/linkcheck
98+
echo.
99+
echo.Link check complete; look for any errors in the above output ^
100+
or in build/linkcheck/output.txt.
101+
goto end
102+
)
103+
104+
if "%1" == "doctest" (
105+
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% build/doctest
106+
echo.
107+
echo.Testing of doctests in the sources finished, look at the ^
108+
results in build/doctest/output.txt.
109+
goto end
110+
)
111+
112+
:end

‎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)