Skip to content

Commit 44b7b5c

Browse files
author
Nick Groenen
committed
Add new website/documentation (using Sphinx)
1 parent 36be4dd commit 44b7b5c

Some content is hidden

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

52 files changed

+6049
-1
lines changed

‎.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,7 @@ config_campfire.py
1212
config_hipchat.py
1313
config_irc.py
1414
config_xmpp.py
15-
15+
/docs/_build
16+
/docs/_gh-pages
17+
/docs/errbot.rst
18+
/docs/errbot.*.rst

‎docs/Makefile

Lines changed: 194 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,194 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXAPIDOC = sphinx-apidoc
8+
PAPER =
9+
BUILDDIR = _build
10+
PAGESURL = [email protected]:gbin/err.git
11+
PAGESDIR = _gh-pages
12+
EXTRADIR = _extra
13+
14+
# User-friendly check for sphinx-build
15+
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
16+
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
17+
endif
18+
19+
# Internal variables.
20+
PAPEROPT_a4 = -D latex_paper_size=a4
21+
PAPEROPT_letter = -D latex_paper_size=letter
22+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
23+
# the i18n builder cannot share the environment and doctrees with the others
24+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
25+
26+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext gh-pages apidoc
27+
28+
help:
29+
@echo "Please use \`make <target>' where <target> is one of"
30+
@echo " html to make standalone HTML files"
31+
@echo " dirhtml to make HTML files named index.html in directories"
32+
@echo " singlehtml to make a single large HTML file"
33+
@echo " pickle to make pickle files"
34+
@echo " json to make JSON files"
35+
@echo " htmlhelp to make HTML files and a HTML help project"
36+
@echo " qthelp to make HTML files and a qthelp project"
37+
@echo " devhelp to make HTML files and a Devhelp project"
38+
@echo " epub to make an epub"
39+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
40+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
41+
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
42+
@echo " text to make text files"
43+
@echo " man to make manual pages"
44+
@echo " texinfo to make Texinfo files"
45+
@echo " info to make Texinfo files and run them through makeinfo"
46+
@echo " gettext to make PO message catalogs"
47+
@echo " changes to make an overview of all changed/added/deprecated items"
48+
@echo " xml to make Docutils-native XML files"
49+
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
50+
@echo " linkcheck to check all external links for integrity"
51+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
52+
53+
clean:
54+
rm -rf $(BUILDDIR)/*
55+
56+
gh-pages: apidoc dirhtml
57+
test -e $(PAGESDIR) && (cd $(PAGESDIR) && git pull) || git clone $(PAGESURL) $(PAGESDIR)
58+
cd $(PAGESDIR) && git checkout gh-pages
59+
rm -r $(PAGESDIR)/*
60+
cp -r $(BUILDDIR)/dirhtml/* $(PAGESDIR)/
61+
cp -r $(EXTRADIR)/* $(PAGESDIR)/
62+
cd $(PAGESDIR) && git add --all . && git commit --message "Sphinx autobuild"
63+
@echo
64+
@echo "GitHub pages are built and ready, just waiting to be pushed from the $(PAGESDIR) directory"
65+
66+
apidoc:
67+
$(SPHINXAPIDOC) --separate -f -o . ../errbot
68+
69+
html: apidoc
70+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
71+
@echo
72+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
73+
74+
dirhtml: apidoc
75+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
76+
@echo
77+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
78+
79+
singlehtml:
80+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
81+
@echo
82+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
83+
84+
pickle:
85+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
86+
@echo
87+
@echo "Build finished; now you can process the pickle files."
88+
89+
json:
90+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
91+
@echo
92+
@echo "Build finished; now you can process the JSON files."
93+
94+
htmlhelp:
95+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
96+
@echo
97+
@echo "Build finished; now you can run HTML Help Workshop with the" \
98+
".hhp project file in $(BUILDDIR)/htmlhelp."
99+
100+
qthelp:
101+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
102+
@echo
103+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
104+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
105+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Err.qhcp"
106+
@echo "To view the help file:"
107+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Err.qhc"
108+
109+
devhelp:
110+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
111+
@echo
112+
@echo "Build finished."
113+
@echo "To view the help file:"
114+
@echo "# mkdir -p $$HOME/.local/share/devhelp/Err"
115+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Err"
116+
@echo "# devhelp"
117+
118+
epub:
119+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
120+
@echo
121+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
122+
123+
latex:
124+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125+
@echo
126+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
127+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
128+
"(use \`make latexpdf' here to do that automatically)."
129+
130+
latexpdf:
131+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
132+
@echo "Running LaTeX files through pdflatex..."
133+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
134+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
135+
136+
latexpdfja:
137+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
138+
@echo "Running LaTeX files through platex and dvipdfmx..."
139+
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
140+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
141+
142+
text:
143+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
144+
@echo
145+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
146+
147+
man:
148+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
149+
@echo
150+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
151+
152+
texinfo:
153+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
154+
@echo
155+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
156+
@echo "Run \`make' in that directory to run these through makeinfo" \
157+
"(use \`make info' here to do that automatically)."
158+
159+
info:
160+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
161+
@echo "Running Texinfo files through makeinfo..."
162+
make -C $(BUILDDIR)/texinfo info
163+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
164+
165+
gettext:
166+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
167+
@echo
168+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
169+
170+
changes:
171+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
172+
@echo
173+
@echo "The overview file is in $(BUILDDIR)/changes."
174+
175+
linkcheck:
176+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
177+
@echo
178+
@echo "Link check complete; look for any errors in the above output " \
179+
"or in $(BUILDDIR)/linkcheck/output.txt."
180+
181+
doctest:
182+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
183+
@echo "Testing of doctests in the sources finished, look at the " \
184+
"results in $(BUILDDIR)/doctest/output.txt."
185+
186+
xml:
187+
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
188+
@echo
189+
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
190+
191+
pseudoxml:
192+
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
193+
@echo
194+
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

‎docs/_extra/.nojekyll

Whitespace-only changes.

‎docs/_extra/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
www.errbot.net

‎docs/_static/err.png

5.66 KB
Loading

‎docs/_static/err.xcf

19.6 KB
Binary file not shown.

‎docs/_static/err_speech.png

10.1 KB
Loading

‎docs/_static/fancybox/blank.gif

43 Bytes
Loading

‎docs/_static/fancybox/fancybox_loading.gif

6.41 KB
Loading

‎docs/_static/fancybox/[email protected]

13.7 KB
Loading

‎docs/_static/fancybox/fancybox_overlay.png

1003 Bytes
Loading

‎docs/_static/fancybox/fancybox_sprite.png

1.33 KB
Loading

‎docs/_static/fancybox/[email protected]

6.4 KB
Loading

‎docs/_static/fancybox/helpers/fancybox_buttons.png

1.05 KB
Loading

‎docs/_static/fancybox/helpers/jquery.fancybox-buttons.css

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
#fancybox-buttons {
2+
position: fixed;
3+
left: 0;
4+
width: 100%;
5+
z-index: 8050;
6+
}
7+
8+
#fancybox-buttons.top {
9+
top: 10px;
10+
}
11+
12+
#fancybox-buttons.bottom {
13+
bottom: 10px;
14+
}
15+
16+
#fancybox-buttons ul {
17+
display: block;
18+
width: 166px;
19+
height: 30px;
20+
margin: 0 auto;
21+
padding: 0;
22+
list-style: none;
23+
border: 1px solid #111;
24+
border-radius: 3px;
25+
-webkit-box-shadow: inset 0 0 0 1px rgba(255,255,255,.05);
26+
-moz-box-shadow: inset 0 0 0 1px rgba(255,255,255,.05);
27+
box-shadow: inset 0 0 0 1px rgba(255,255,255,.05);
28+
background: rgb(50,50,50);
29+
background: -moz-linear-gradient(top, rgb(68,68,68) 0%, rgb(52,52,52) 50%, rgb(41,41,41) 50%, rgb(51,51,51) 100%);
30+
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,rgb(68,68,68)), color-stop(50%,rgb(52,52,52)), color-stop(50%,rgb(41,41,41)), color-stop(100%,rgb(51,51,51)));
31+
background: -webkit-linear-gradient(top, rgb(68,68,68) 0%,rgb(52,52,52) 50%,rgb(41,41,41) 50%,rgb(51,51,51) 100%);
32+
background: -o-linear-gradient(top, rgb(68,68,68) 0%,rgb(52,52,52) 50%,rgb(41,41,41) 50%,rgb(51,51,51) 100%);
33+
background: -ms-linear-gradient(top, rgb(68,68,68) 0%,rgb(52,52,52) 50%,rgb(41,41,41) 50%,rgb(51,51,51) 100%);
34+
background: linear-gradient(top, rgb(68,68,68) 0%,rgb(52,52,52) 50%,rgb(41,41,41) 50%,rgb(51,51,51) 100%);
35+
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#444444', endColorstr='#222222',GradientType=0 );
36+
}
37+
38+
#fancybox-buttons ul li {
39+
float: left;
40+
margin: 0;
41+
padding: 0;
42+
}
43+
44+
#fancybox-buttons a {
45+
display: block;
46+
width: 30px;
47+
height: 30px;
48+
text-indent: -9999px;
49+
background-color: transparent;
50+
background-image: url('fancybox_buttons.png');
51+
background-repeat: no-repeat;
52+
outline: none;
53+
opacity: 0.8;
54+
}
55+
56+
#fancybox-buttons a:hover {
57+
opacity: 1;
58+
}
59+
60+
#fancybox-buttons a.btnPrev {
61+
background-position: 5px 0;
62+
}
63+
64+
#fancybox-buttons a.btnNext {
65+
background-position: -33px 0;
66+
border-right: 1px solid #3e3e3e;
67+
}
68+
69+
#fancybox-buttons a.btnPlay {
70+
background-position: 0 -30px;
71+
}
72+
73+
#fancybox-buttons a.btnPlayOn {
74+
background-position: -30px -30px;
75+
}
76+
77+
#fancybox-buttons a.btnToggle {
78+
background-position: 3px -60px;
79+
border-left: 1px solid #111;
80+
border-right: 1px solid #3e3e3e;
81+
width: 35px
82+
}
83+
84+
#fancybox-buttons a.btnToggleOn {
85+
background-position: -27px -60px;
86+
}
87+
88+
#fancybox-buttons a.btnClose {
89+
border-left: 1px solid #111;
90+
width: 35px;
91+
background-position: -56px 0px;
92+
}
93+
94+
#fancybox-buttons a.btnDisabled {
95+
opacity : 0.4;
96+
cursor: default;
97+
}

0 commit comments

Comments
 (0)