Merge pull request #65 from heuer/feature/doc_fixes

Hugo Osvaldo Barrera · web-flow · commit 6f4517d8c20f · 2020-03-30T14:01:52.000+02:00
Fixed Sphinx errors
diff --git a/docs/source/_static/images/pybarcode.png b/docs/source/_static/images/pybarcode.png
diff --git a/docs/source/_static/images/pybarcode_small.png b/docs/source/_static/images/pybarcode_small.png
diff --git a/docs/source/barcode.rst b/docs/source/barcode.rst
@@ -2,7 +2,7 @@ Introduction
 ============
 
 This package was created to have barcodes available with pure-python.
-Pillow_ is required for exporting for exporting images (png, jpg), although not
+Pillow_ is required for exporting images (png, jpg), although not
 for SVGs.
 
 All you need to create a barcode is to know the system (EAN, UPC, ...)
@@ -11,8 +11,6 @@ need the checksum, it will be calculated automatically. In some systems
 (Code 39) the checksum is optional, there you can give the `add_checksum`
 keyword argument (default is True).
 
-As of version 0.7beta3 Python 3 is supported, but not well tested.
-
 .. _Pillow: https://python-pillow.org/
 
 Creating barcodes as SVG
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -11,8 +11,6 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
-import os
 import sys
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -21,7 +19,7 @@
 # sys.path.append(os.path.abspath('.'))
 from barcode import version
 
-LOGO = os.path.join("images", "pybarcode_small.png")
+LOGO = '_static/images/pybarcode_small.png'
 
 # -- General configuration ----------------------------------------------------
 
@@ -133,7 +131,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
+html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,7 +1,7 @@
 ㊙️ python-barcode's documentation
-=================================
+===================================
 
-.. image:: /images/pybarcode.png
+.. image:: _static/images/pybarcode.png
 
 Contents
 --------
diff --git a/docs/source/writers/image.rst b/docs/source/writers/image.rst
@@ -3,7 +3,7 @@ python-barcode ImageWriter
 
 .. versionadded:: 0.4b1
 
-Creates barcodes as image. All imagetypes supported by Pillow are availble.
+Creates barcodes as image. All imagetypes supported by Pillow are available.
 
 Special Options
 ---------------
