Skip to content

Commit 7a188d9

Browse files
amiroucheamirouche
committed
added some doc
1 parent e57146c commit 7a188d9

66 files changed

Lines changed: 21831 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*pyc
2+
*~

‎doc/Makefile‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
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+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
16+
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18+
19+
help:
20+
@echo "Please use \`make <target>' where <target> is one of"
21+
@echo " html to make standalone HTML files"
22+
@echo " dirhtml to make HTML files named index.html in directories"
23+
@echo " singlehtml to make a single large HTML file"
24+
@echo " pickle to make pickle files"
25+
@echo " json to make JSON files"
26+
@echo " htmlhelp to make HTML files and a HTML help project"
27+
@echo " qthelp to make HTML files and a qthelp project"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
32+
@echo " text to make text files"
33+
@echo " man to make manual pages"
34+
@echo " texinfo to make Texinfo files"
35+
@echo " info to make Texinfo files and run them through makeinfo"
36+
@echo " gettext to make PO message catalogs"
37+
@echo " changes to make an overview of all changed/added/deprecated items"
38+
@echo " linkcheck to check all external links for integrity"
39+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
40+
41+
clean:
42+
-rm -rf $(BUILDDIR)/*
43+
44+
html:
45+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48+
49+
dirhtml:
50+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51+
@echo
52+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53+
54+
singlehtml:
55+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56+
@echo
57+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58+
59+
pickle:
60+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61+
@echo
62+
@echo "Build finished; now you can process the pickle files."
63+
64+
json:
65+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66+
@echo
67+
@echo "Build finished; now you can process the JSON files."
68+
69+
htmlhelp:
70+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71+
@echo
72+
@echo "Build finished; now you can run HTML Help Workshop with the" \
73+
".hhp project file in $(BUILDDIR)/htmlhelp."
74+
75+
qthelp:
76+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77+
@echo
78+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
79+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonScript.qhcp"
81+
@echo "To view the help file:"
82+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonScript.qhc"
83+
84+
devhelp:
85+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86+
@echo
87+
@echo "Build finished."
88+
@echo "To view the help file:"
89+
@echo "# mkdir -p $$HOME/.local/share/devhelp/PythonScript"
90+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonScript"
91+
@echo "# devhelp"
92+
93+
epub:
94+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95+
@echo
96+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97+
98+
latex:
99+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100+
@echo
101+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
103+
"(use \`make latexpdf' here to do that automatically)."
104+
105+
latexpdf:
106+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107+
@echo "Running LaTeX files through pdflatex..."
108+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
109+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110+
111+
text:
112+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113+
@echo
114+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
115+
116+
man:
117+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118+
@echo
119+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120+
121+
texinfo:
122+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123+
@echo
124+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125+
@echo "Run \`make' in that directory to run these through makeinfo" \
126+
"(use \`make info' here to do that automatically)."
127+
128+
info:
129+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130+
@echo "Running Texinfo files through makeinfo..."
131+
make -C $(BUILDDIR)/texinfo info
132+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133+
134+
gettext:
135+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136+
@echo
137+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138+
139+
changes:
140+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141+
@echo
142+
@echo "The overview file is in $(BUILDDIR)/changes."
143+
144+
linkcheck:
145+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146+
@echo
147+
@echo "Link check complete; look for any errors in the above output " \
148+
"or in $(BUILDDIR)/linkcheck/output.txt."
149+
150+
doctest:
151+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152+
@echo "Testing of doctests in the sources finished, look at the " \
153+
"results in $(BUILDDIR)/doctest/output.txt."

‎doc/foundation/globaltoc.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<li class="dropdown globaltoc-container">
2+
<a href="{{ pathto(master_doc) }}"
3+
class="dropdown-toggle"
4+
data-toggle="dropdown">{{ _('Site') }} <b class="caret"></b></a>
5+
<ul class="dropdown-menu globaltoc"
6+
>{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False) }}</ul>
7+
</li>

‎doc/foundation/layout.html‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
{% extends "basic/layout.html" %}
2+
{% set script_files = script_files %}
3+
{% set css_files = css_files + ['_static/css/foundation.min.css', '_static/css/app.css'] %}
4+
5+
{%- block doctype -%}
6+
<!DOCTYPE html>
7+
{%- endblock %}
8+
9+
{%- block extrahead %}
10+
<meta charset='utf-8'>
11+
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
12+
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
13+
<meta name="apple-mobile-web-app-capable" content="yes">
14+
{% endblock %}
15+
16+
{# Silence the sidebar's, relbar's #}
17+
{% block header %}{% endblock %}
18+
{% block sidebar1 %}{% endblock %}
19+
{% block sidebar2 %}{% endblock %}
20+
{% block relbar1 %}{% endblock %}
21+
{% block relbar2 %}{% endblock %}
22+
{% block sidebarsourcelink %}{% endblock %}
23+
24+
{% block content %}
25+
<div class="container">
26+
<div class="row">
27+
<div class="large-9 columns">{% block body %}{% endblock %}</div>
28+
<div class="large-3 columns">
29+
<ul class="side-nav">
30+
{% if prev %}
31+
<li>Previous: <a href="{{ prev.link|e }}">{{ prev.title }}</a></li>
32+
<li class="divider"></li>
33+
{% endif %}
34+
35+
{{ toc }}
36+
{% if next %}
37+
<li class="divider"></li>
38+
<li>Next: <a href="{{ next.link|e }}">{{ next.title }}</a></li>
39+
{% endif %}
40+
</ul>
41+
</div>
42+
</div>
43+
</div>
44+
{% endblock %}
45+
46+
{%- block footer %}
47+
<footer class="footer">
48+
<div class="container">
49+
<p class="pull-right">
50+
<a href="#">Back to top</a>
51+
{% if theme_source_link_position == "footer" %}
52+
<br/>
53+
{% include "sourcelink.html" %}
54+
{% endif %}
55+
</p>
56+
<p>
57+
{%- if show_copyright %}
58+
{%- if hasdoc('copyright') %}
59+
{% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}<br/>
60+
{%- else %}
61+
{% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}<br/>
62+
{%- endif %}
63+
{%- endif %}
64+
{%- if last_updated %}
65+
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}<br/>
66+
{%- endif %}
67+
{%- if show_sphinx %}
68+
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}<br/>
69+
{%- endif %}
70+
</p>
71+
</div>
72+
</footer>
73+
{%- endblock %}

‎doc/foundation/localtoc.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<li class="dropdown">
2+
<a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ _('Page') }} <b class="caret"></b></a>
3+
<ul class="dropdown-menu localtoc">{{ toc }}</ul>
4+
</li>

‎doc/foundation/relations.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{%- if prev %}
2+
<li><a href="{{ prev.link|e }}"
3+
title="{{ _('previous chapter') }}">{{ "&laquo;"|safe }} {{ prev.title }}</a></li>
4+
{%- endif %}
5+
{%- if next %}
6+
<li><a href="{{ next.link|e }}"
7+
title="{{ _('next chapter') }}">{{ next.title }} {{ "&raquo;"|safe }}</a></li>
8+
{%- endif %}

‎doc/foundation/searchbox.html‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{%- if pagename != "search" %}
2+
<form class="navbar-search pull-right" style="margin-bottom:-3px;" action="{{ pathto('search') }}" method="get">
3+
<input type="text" name="q" placeholder="Search" />
4+
<input type="hidden" name="check_keywords" value="yes" />
5+
<input type="hidden" name="area" value="default" />
6+
</form>
7+
{%- endif %}

‎doc/foundation/sourcelink.html‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{%- if show_source and has_source and sourcename %}
2+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}"
3+
rel="nofollow">{{ _('Source') }}</a>
4+
{%- endif %}

‎doc/foundation/static/css/accessibility_foundicons.css‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
/* font-face */
2+
@font-face {
3+
font-family: "AccessibilityFoundicons";
4+
src: url("../fonts/accessibility_foundicons.eot");
5+
src: url("../fonts/accessibility_foundicons.eot?#iefix") format("embedded-opentype"), url("../fonts/accessibility_foundicons.woff") format("woff"), url("../fonts/accessibility_foundicons.ttf") format("truetype"), url("../fonts/accessibility_foundicons.svg#AccessibilityFoundicons") format("svg");
6+
font-weight: normal;
7+
font-style: normal;
8+
}
9+
10+
/* global foundicon styles */
11+
[class*="foundicon-"] {
12+
display: inline;
13+
width: auto;
14+
height: auto;
15+
line-height: inherit;
16+
vertical-align: baseline;
17+
background-image: none;
18+
background-position: 0 0;
19+
background-repeat: repeat;
20+
}
21+
22+
[class*="foundicon-"]:before {
23+
font-family: "AccessibilityFoundicons";
24+
font-weight: normal;
25+
font-style: normal;
26+
text-decoration: inherit;
27+
}
28+
29+
/* icons */
30+
.foundicon-wheelchair:before {
31+
content: "\f000";
32+
}
33+
34+
.foundicon-speaker:before {
35+
content: "\f001";
36+
}
37+
38+
.foundicon-fontsize:before {
39+
content: "\f002";
40+
}
41+
42+
.foundicon-eject:before {
43+
content: "\f003";
44+
}
45+
46+
.foundicon-view-mode:before {
47+
content: "\f004";
48+
}
49+
50+
.foundicon-eyeball:before {
51+
content: "\f005";
52+
}
53+
54+
.foundicon-asl:before {
55+
content: "\f006";
56+
}
57+
58+
.foundicon-person:before {
59+
content: "\f007";
60+
}
61+
62+
.foundicon-question:before {
63+
content: "\f008";
64+
}
65+
66+
.foundicon-adult:before {
67+
content: "\f009";
68+
}
69+
70+
.foundicon-child:before {
71+
content: "\f00a";
72+
}
73+
74+
.foundicon-glasses:before {
75+
content: "\f00b";
76+
}
77+
78+
.foundicon-cc:before {
79+
content: "\f00c";
80+
}
81+
82+
.foundicon-blind:before {
83+
content: "\f00d";
84+
}
85+
86+
.foundicon-braille:before {
87+
content: "\f00e";
88+
}
89+
90+
.foundicon-iphone-home:before {
91+
content: "\f00f";
92+
}
93+
94+
.foundicon-w3c:before {
95+
content: "\f010";
96+
}
97+
98+
.foundicon-css:before {
99+
content: "\f011";
100+
}
101+
102+
.foundicon-key:before {
103+
content: "\f012";
104+
}
105+
106+
.foundicon-hearing-impaired:before {
107+
content: "\f013";
108+
}
109+
110+
.foundicon-male:before {
111+
content: "\f014";
112+
}
113+
114+
.foundicon-female:before {
115+
content: "\f015";
116+
}
117+
118+
.foundicon-network:before {
119+
content: "\f016";
120+
}
121+
122+
.foundicon-guidedog:before {
123+
content: "\f017";
124+
}
125+
126+
.foundicon-universal-access:before {
127+
content: "\f018";
128+
}
129+
130+
.foundicon-elevator:before {
131+
content: "\f019";
132+
}

0 commit comments

Comments
 (0)