summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2012-02-01 08:17:51 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2012-02-01 08:17:51 +0000
commitb9b6644ae32d3d489dfe8ca61854dc26bcc75822 (patch)
tree5f71b465ce98badcea0712d059f212ffb0e45372 /docs
parenta049ec2fed898d8c828de74c8f4449f2378c9545 (diff)
revert to hardcoded version strings
before, we tried to be smart and wrote an auto-generated version string via `git describe` to alot.VERSION at setup time that got read by alot.__init__ later on. This reverts to a hardcoded version string in alot.__version__. It makes tedious calls to `git update-index --assume-unchanged VERSION` unnecessary and makes life easier for packagers. closes issue #299
Diffstat (limited to 'docs')
-rw-r--r--docs/dev/source/index.rst11
1 files changed, 3 insertions, 8 deletions
diff --git a/docs/dev/source/index.rst b/docs/dev/source/index.rst
index f9e0cf15..a112a340 100644
--- a/docs/dev/source/index.rst
+++ b/docs/dev/source/index.rst
@@ -35,19 +35,14 @@ Here are a few more things you should know and check before you send pull reques
white spaces. If in doubt, use an `automatic tool <http://pypi.python.org/pypi/pep8>`_
to verify your code.
-* don't check in :file:`alot/VERSION`. Our current solution for autogenerated version
- strings will update the content of this file when calling `setup.py` but we need
- this file checked in as fallback for the installation to succeed from tarballs. So::
-
- git update-index --assume-unchanged alot/VERSION
-
* Document! Needless to say, we want readable and well documented code. Moreover,
- * Please use `sphinx directives <http://sphinx.pocoo.org/rest.html>`_ to document
+ * use `sphinx directives <http://sphinx.pocoo.org/rest.html>`_ to document
the parameters and return values of your methods so that we maintain up-to-date API docs.
* Make sure your patch doesn't break the API docs. The build service at `readthedocs.org <http:alot.rtfd.org>`_
is fragile when it comes to new import statements in our code.
- * If you implemented a new feature please update the user manual in :file:`/docs/user` accordingly.
+ * If you implemented a new feature, update the user manual in :file:`/docs/user` accordingly.
+
Contents
========