Skip to content

Commit b587602

Browse files
committed
Add some missing barcodes to the documentation
Fixes: #154 Fixes: #2
1 parent 25677ec commit b587602

2 files changed

Lines changed: 54 additions & 7 deletions

File tree

barcode/ean.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,8 @@ def render(self, writer_options=None, text=None):
124124

125125

126126
class EuropeanArticleNumber13WithGuard(EuropeanArticleNumber13):
127+
"""A shortcut to EAN-13 with ``guardbar=True``."""
128+
127129
name = "EAN-13 with guards"
128130

129131
def __init__(self, ean, writer=None, no_checksum=False, guardbar=True) -> None:
@@ -188,6 +190,8 @@ def get_fullcode(self):
188190

189191

190192
class EuropeanArticleNumber8WithGuard(EuropeanArticleNumber8):
193+
"""A shortcut to EAN-8 with ``guardbar=True``."""
194+
191195
name = "EAN-8 with guards"
192196

193197
def __init__(self, ean, writer=None, no_checksum=False, guardbar=True) -> None:

docs/supported-formats.rst

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@ Supported Formats
44
The following are the supported barcode formats.
55
PRs for other code formats are welcome!
66

7+
Codabar
8+
-------
9+
10+
.. inheritance-diagram:: barcode.codabar.CODABAR
11+
:parts: 1
12+
13+
.. autoclass:: barcode.codabar.CODABAR
14+
:members:
15+
716
Code 39
817
-------
918

@@ -33,25 +42,39 @@ PZN (aka: PZN7)
3342
.. autoclass:: barcode.codex.PZN
3443
:members:
3544

36-
3745
EAN-13
3846
------
3947

40-
.. inheritance-diagram:: barcode.ean.EuropeanArticleNumber13
48+
.. inheritance-diagram:: barcode.ean.EuropeanArticleNumber13WithGuard
4149
:parts: 1
4250

4351
.. autoclass:: barcode.ean.EuropeanArticleNumber13
4452
:members:
4553

54+
.. autoclass:: barcode.ean.EuropeanArticleNumber13WithGuard
55+
:members:
56+
4657
EAN-8
4758
-----
4859

49-
.. inheritance-diagram:: barcode.ean.EuropeanArticleNumber8
60+
.. inheritance-diagram:: barcode.ean.EuropeanArticleNumber8WithGuard
5061
:parts: 1
5162

5263
.. autoclass:: barcode.ean.EuropeanArticleNumber8
5364
:members:
5465

66+
.. autoclass:: barcode.ean.EuropeanArticleNumber8WithGuard
67+
:members:
68+
69+
EAN-14
70+
------
71+
72+
.. inheritance-diagram:: barcode.ean.EuropeanArticleNumber14
73+
:parts: 1
74+
75+
.. autoclass:: barcode.ean.EuropeanArticleNumber14
76+
:members:
77+
5578
JAN
5679
---
5780

@@ -61,8 +84,8 @@ JAN
6184
.. autoclass:: barcode.ean.JapanArticleNumber
6285
:members:
6386

64-
ISBN-13
65-
-------
87+
ISBN-13 (aka: GS1, ISBN)
88+
------------------------
6689

6790
.. inheritance-diagram:: barcode.isxn.InternationalStandardBookNumber13
6891
:parts: 1
@@ -97,8 +120,8 @@ UPC-A
97120
.. autoclass:: barcode.upc.UniversalProductCodeA
98121
:members:
99122

100-
EAN14
101-
-----
123+
EAN14 (aka: GTIN)
124+
-----------------
102125

103126
.. inheritance-diagram:: barcode.ean.EuropeanArticleNumber14
104127
:parts: 1
@@ -116,3 +139,23 @@ GS1-128
116139

117140
.. autoclass:: barcode.codex.Gs1_128
118141
:members:
142+
143+
ITF
144+
---
145+
146+
.. versionadded:: 0.8.0
147+
148+
.. inheritance-diagram:: barcode.itf.ITF
149+
:parts: 1
150+
151+
.. autoclass:: barcode.itf.ITF
152+
:members:
153+
154+
UPCA (aka UPC)
155+
--------------
156+
157+
.. inheritance-diagram:: barcode.upc.UPCA
158+
:parts: 1
159+
160+
.. autoclass:: barcode.upc.UPCA
161+
:members:

0 commit comments

Comments
 (0)