aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSebastian Spaeth <sebastian@sspaeth.de>2010-03-22 12:32:44 +0100
committerSebastian Spaeth <sebastian@sspaeth.de>2010-03-22 12:32:44 +0100
commit2dd0cf8f5bbf63c0e0a423344de95e9d433bf7af (patch)
tree44b2eb974c2e22912cb4c9c028371af538676a89 /docs
parent2b32acacbd02ad27e96a2eb234ff3d92de5e87d4 (diff)
Make __VERSION__ available via cnotmuch.notmuch.__VERSION__ and improve README
Rather than hardcoding the version in various places, we export it from the module itself. Also improve the README somewhat.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/conf.py9
-rw-r--r--docs/source/index.rst2
2 files changed, 6 insertions, 5 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index ee22837f..ca959894 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -16,8 +16,9 @@ import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath('../..'))
+sys.path.insert(0,os.path.abspath('../..'))
+from cnotmuch.notmuch import __VERSION__,__AUTHOR__
# -- General configuration -----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
@@ -39,16 +40,16 @@ master_doc = 'index'
# General information about the project.
project = u'cnotmuch'
-copyright = u'2010, Sebastian Spaeth'
+copyright = u'2010, ' + __AUTHOR__
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '0.1'
+version = __VERSION__
# The full version, including alpha/beta/rc tags.
-release = '0.1'
+release = __VERSION__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/source/index.rst b/docs/source/index.rst
index e04bc843..468a3c91 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -13,7 +13,7 @@ The classes :class:`notmuch.Database`, :class:`notmuch.Query` provide most of th
:License: This module is covered under the GNU GPL v3 (or later).
-This page contains the main API overview. More information on specific topics can be found on the following pages: (none here yet)
+This page contains the main API overview of cnotmuch |release|. More information on specific topics can be found on the following pages: (none here yet)
Notmuch can be imported as::