Make sure README works on pypi.

OnroerendErfgoed · Dec 18, 2014 · 8ad9701 · 8ad9701
1 parent d1d00cb
commit 8ad9701
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -10,4 +10,20 @@ A SQLAlchemy implementation of the skosprovider_ interface.
 .. image:: https://badge.fury.io/py/skosprovider_sqlalchemy.png
         :target: http://badge.fury.io/py/skosprovider_sqlalchemy
 
+Building the docs
+-----------------
+
+More information about this library can be found in `docs`. The docs can be 
+built using `Sphinx <http://sphinx-doc.org>`_.
+
+Please make sure you have installed Sphinx in the same environment where 
+skosprovider_sqlalchemy is present.
+
+.. code-block:: bash
+
+    # activate your virtual env
+    $ pip install -r requirements-dev.txt
+    $ cd docs
+    $ make html
+
 .. _skosprovider: https://github.com/koenedaele/skosprovider
diff --git a/setup.py b/setup.py
@@ -21,8 +21,7 @@
     name='skosprovider_sqlalchemy',
     version='0.4.1',
     description='A sqlAlchemy implementation of skosprovider.',
-    long_description=open('README.rst').read() + '\n\n' +
-                     open('HISTORY.rst').read(),
+    long_description=open('README.rst').read(),
     author='Koen Van Daele',
     author_email='koen_van_daele@telenet.be',
     url='http://github.com/koenedaele/skosprovider_sqlalchemy',