diff options
author | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2015-04-01 01:16:30 +0200 |
---|---|---|
committer | Raphaël Barrois <raphael.barrois@polytechnique.org> | 2015-04-01 01:16:30 +0200 |
commit | 5525528da2e00579777f5c2ce392a629b2634ff2 (patch) | |
tree | 4cd4e8dc1c1c900f79110750fa4091638c66a22b | |
parent | 54da2367dfc819c198ef5f48c1bffcb87a9c1c9e (diff) | |
download | semantic-version-5525528da2e00579777f5c2ce392a629b2634ff2.tar.gz |
Fix README (Closes #19).
Also fixes README rendering on PyPI, hopefully.
-rw-r--r-- | README.rst | 7 | ||||
-rwxr-xr-x | setup.py | 9 |
2 files changed, 10 insertions, 6 deletions
@@ -1,8 +1,3 @@ -.. python-semanticversion documentation master file, created by - sphinx-quickstart on Wed May 16 10:41:34 2012. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - python-semanticversion ====================== @@ -27,7 +22,7 @@ Links Getting started =============== -Intall the package from `PyPI`_, using pip: +Install the package from `PyPI`_, using pip: .. code-block:: sh @@ -25,6 +25,14 @@ def get_version(package_name): return '0.1.0' +def clean_readme(fname): + with codecs.open(fname, 'r', 'utf-8') as f: + return '\n'.join( + re.sub(r':\w+:`([^`]+?)( <[^<>]+>)?`', r'``\1``', line) + for line in f + ) + + PACKAGE = 'semantic_version' @@ -34,6 +42,7 @@ setup( author="Raphaël Barrois", author_email="raphael.barrois+semver@polytechnique.org", description="A library implementing the 'SemVer' scheme.", + long_description=clean_readme('README.rst'), license='BSD', keywords=['semantic version', 'versioning', 'version'], url='https://github.com/rbarrois/python-semanticversion', |