Skip to content

Commit 679bf00

Browse files
committed
use theme provided by pallets-sphinx-themes
1 parent b354c37 commit 679bf00

26 files changed

+164
-659
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ _mailinglist
1111
.tox
1212
.cache/
1313
.idea/
14+
docs/_build/
1415

1516
# Coverage reports
1617
htmlcov

.gitmodules

Lines changed: 0 additions & 3 deletions
This file was deleted.

CHANGES

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ Released on July 27th 2010, codename Whisky
524524
prefix. This makes it possible to bind a whole module to a
525525
configurable subdomain.
526526

527-
.. _blinker: https://pypi.python.org/pypi/blinker
527+
.. _blinker: https://pypi.org/project/blinker/
528528

529529
Version 0.5.2
530530
-------------

docs/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/Makefile

Lines changed: 10 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,20 @@
1-
# Makefile for Sphinx documentation
1+
# Minimal makefile for Sphinx documentation
22
#
33

44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
7-
PAPER =
7+
SPHINXPROJ = Flask
8+
SOURCEDIR = .
89
BUILDDIR = _build
910

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) .
14-
15-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp epub latex changes linkcheck doctest
16-
11+
# Put it first so that "make" without argument is like "make help".
1712
help:
18-
@echo "Please use \`make <target>' where <target> is one of"
19-
@echo " html to make standalone HTML files"
20-
@echo " dirhtml to make HTML files named index.html in directories"
21-
@echo " singlehtml to make a single large HTML file"
22-
@echo " pickle to make pickle files"
23-
@echo " json to make JSON files"
24-
@echo " htmlhelp to make HTML files and a HTML help project"
25-
@echo " qthelp to make HTML files and a qthelp project"
26-
@echo " devhelp to make HTML files and a Devhelp project"
27-
@echo " epub to make an epub"
28-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29-
@echo " latexpdf to make LaTeX files and run them through pdflatex"
30-
@echo " changes to make an overview of all changed/added/deprecated items"
31-
@echo " linkcheck to check all external links for integrity"
32-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
33-
34-
clean:
35-
-rm -rf $(BUILDDIR)/*
36-
37-
html:
38-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
39-
@echo
40-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
41-
42-
dirhtml:
43-
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
44-
@echo
45-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
46-
47-
singlehtml:
48-
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
49-
@echo
50-
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
51-
52-
pickle:
53-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
54-
@echo
55-
@echo "Build finished; now you can process the pickle files."
56-
57-
json:
58-
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
59-
@echo
60-
@echo "Build finished; now you can process the JSON files."
61-
62-
htmlhelp:
63-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
64-
@echo
65-
@echo "Build finished; now you can run HTML Help Workshop with the" \
66-
".hhp project file in $(BUILDDIR)/htmlhelp."
67-
68-
qthelp:
69-
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
70-
@echo
71-
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
72-
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
73-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Flask.qhcp"
74-
@echo "To view the help file:"
75-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Flask.qhc"
76-
77-
devhelp:
78-
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
79-
@echo
80-
@echo "Build finished."
81-
@echo "To view the help file:"
82-
@echo "# mkdir -p $$HOME/.local/share/devhelp/Flask"
83-
@echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/Flask"
84-
@echo "# devhelp"
85-
86-
epub:
87-
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
88-
@echo
89-
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
90-
91-
latex:
92-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
93-
@echo
94-
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
95-
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
96-
"run these through (pdf)latex."
97-
98-
latexpdf: latex
99-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
100-
@echo "Running LaTeX files through pdflatex..."
101-
make -C _build/latex all-pdf
102-
@echo "pdflatex finished; the PDF files are in _build/latex."
103-
104-
changes:
105-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
106-
@echo
107-
@echo "The overview file is in $(BUILDDIR)/changes."
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
10814

109-
linkcheck:
110-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
111-
@echo
112-
@echo "Link check complete; look for any errors in the above output " \
113-
"or in $(BUILDDIR)/linkcheck/output.txt."
15+
.PHONY: help Makefile
11416

115-
doctest:
116-
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
117-
@echo "Testing of doctests in the sources finished, look at the " \
118-
"results in $(BUILDDIR)/doctest/output.txt."
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_templates/sidebarintro.html

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/_templates/sidebarlogo.html

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/_themes

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -703,7 +703,7 @@ The following signals exist in Flask:
703703
operations, including connecting.
704704

705705

706-
.. _blinker: https://pypi.python.org/pypi/blinker
706+
.. _blinker: https://pypi.org/project/blinker/
707707

708708

709709
Class-Based Views

0 commit comments

Comments
 (0)