Skip to content

Commit 6e9b315

Browse files
committed
Merge branch 'feature/sphinx-docs'
2 parents 5a5a0b4 + 2e917ab commit 6e9b315

19 files changed

+374
-8
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ Flask-QRcode
22
============
33
[![PyPI version](https://badge.fury.io/py/Flask-QRcode.svg)](https://badge.fury.io/py/Flask-QRcode)
44

5-
> A concise Flask extension to render QR codes using [python-qrcode](https://github.com/lincolnloop/python-qrcode)
5+
> A concise Flask extension to easily render QR codes on Jinja2 templates using
6+
[python-qrcode](https://github.com/lincolnloop/python-qrcode)
67

78
![](QRcode.png)
89

@@ -50,7 +51,9 @@ As this is a simple package, the process is pretty straightforward...
5051
pip install -e . # for installing flask_qrcode on editable mode
5152
```
5253
4. Do your magic
53-
5. Pull Request!
54+
5. Provide new tests for your work and check that both this and the old ones
55+
are passing
56+
6. Pull Request!
5457
5558
## Testing:
5659

docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = Flask-QRcode
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
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)
2.71 KB
Loading
1.74 KB
Loading
9.69 KB
Loading
11.5 KB
Loading
2.26 KB
Loading
2.74 KB
Loading
2.27 KB
Loading
978 Bytes
Loading

0 commit comments

Comments
 (0)