Include version in generated documentation.

Author: abcminiuser

MANIFEST.in

@@ -1,3 +1,4 @@
 recursive-include src/StreamDeck
-include *.md
 include src/example.py
+include *.md
+include VERSION

VERSION

@@ -0,0 +1 @@
+0.2.3

doc/source/conf.py

@@ -22,7 +22,12 @@
 
 import sphinx_rtd_theme
 
-sys.path.insert(0, os.path.abspath('../../src'))
+ROOT_PATH = os.path.join("..", "..")
+
+with open(os.path.join(ROOT_PATH, "VERSION"), 'r') as f:
+    package_version = f.read().strip()
+
+sys.path.insert(0, os.path.abspath(os.path.join(ROOT_PATH, 'src')))
 
 
 # -- General configuration ------------------------------------------------
@@ -58,9 +63,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = ''
+version = package_version
 # The full version, including alpha/beta/rc tags.
-release = ''
+release = package_version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -101,9 +106,7 @@
 # so a file named "default.css" will overwrite the built-in "default.css".
 html_static_path = []
 
-html_extra_path = ['../../ExampleDeck.jpg']
-
-html_extra_path = ['../../ExampleDeck.jpg']
+html_extra_path = [os.path.join(ROOT_PATH, 'ExampleDeck.jpg')]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -148,7 +151,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'python-elgato-streamdeck.tex', 'python-elgato-streamdeck Documentation',
+    (master_doc, 'python-elgato-streamdeck.tex', 'StreamDeck Package Documentation',
      'Dean Camera', 'manual'),
 ]
 
@@ -158,7 +161,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'python-elgato-streamdeck', 'python-elgato-streamdeck Documentation',
+    (master_doc, 'python-elgato-streamdeck', 'StreamDeck Package Documentation',
      [author], 1)
 ]
 
@@ -169,10 +172,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'python-elgato-streamdeck', 'python-elgato-streamdeck Documentation',
-     author, 'python-elgato-streamdeck', 'One line description of project.',
+    (master_doc, 'python-elgato-streamdeck', 'StreamDeck Package Documentation',
+     author, 'python-elgato-streamdeck', 'Library to control Elgato StreamDeck devices.',
      'Miscellaneous'),
 ]
-
-
-

setup.py

@@ -1,11 +1,14 @@
 import setuptools
 
+with open("VERSION", 'r') as f:
+    version = f.read().strip()
+
 with open("README.md", 'r') as f:
     long_description = f.read()
 
 setuptools.setup(
    name='streamdeck',
-   version='0.2.3',
+   version=version,
    description='Library to control Elgato StreamDeck devices.',
    author='Dean Camera',
    author_email='[email protected]',