Skip to content

Commit b26eb2c

Browse files
ikanoboriikanobori
committed
The docs directory from which docs.bpython-interpreter.org is built is now included with the main repository so we can have the same branches as our releases instead of keeping track of this twice
1 parent d27ca4b commit b26eb2c

File tree

14 files changed

+1259
-0
lines changed

14 files changed

+1259
-0
lines changed

‎doc/sphinx/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/bpython.qhcp"
64+
@echo "To view the help file:"
65+
@echo "# assistant -collectionFile build/qthelp/bpython.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."

‎doc/sphinx/source/authors.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _authors:
2+
3+
Authors
4+
=======
5+
If you contributed to bpython and want to be on this list please find us
6+
(:ref:`community`) and let us know!
7+
8+
bpython is written and maintained by Bob Farrell
9+
<bob at bpython-interpreter dot org>.
10+
11+
Other contributors are (in alphabetical order):
12+
13+
* Federico Ceratto <federico dot ceratto at gmail dot com>
14+
* Pavel Panchekha <pavpanchekha at gmail dot com>
15+
* Andreas Stuehrk <andreas at bpython-interpreter dot org>
16+
* Simon de Vlieger <simon at ikanobori dot jp>
17+
18+
A big thanks goes out to all the people who help us out by either submitting
19+
patches, helping us determine problems, our package maintainers and of course
20+
everybody who creates issues for us to fix.

‎doc/sphinx/source/bpaste.rst‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. _authors:
2+
3+
bpaste
4+
======
5+
bpaste (http://bpaste.net) is the pastebin which we run for bpython. bpython is
6+
configured by default to paste to this pastebin.
7+
8+
Removal
9+
-------
10+
If you want a paste removed from the pastebin you can email Simon at
11+
simon@ikanobori.jp and he will remove the paste for you, be sure to mention the
12+
paste URL.

0 commit comments

Comments
 (0)