diff options
| -rw-r--r-- | MANIFEST.in | 2 | ||||
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | README.rst | 11 | ||||
| -rw-r--r-- | setup.py | 6 |
4 files changed, 17 insertions, 12 deletions
diff --git a/MANIFEST.in b/MANIFEST.in index 04a2e88..ce51ba3 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include README.md COPYING-GPLV2 COPYING-LGPLV3 MAINTAINERS +include README.rst COPYING-GPLV2 COPYING-LGPLV3 MAINTAINERS include .functests .unittests test-requirements.txt tox.ini test/test.conf recursive-include gluster *.py recursive-include test *.py diff --git a/README.md b/README.md deleted file mode 100644 index c7710b5..0000000 --- a/README.md +++ /dev/null @@ -1,10 +0,0 @@ -### Overview - -This is the official python bindings for the -[GlusterFS](http://www.gluster.org) libgfapi C library interface. - -Complete API reference and documentation can be found at -[ReadTheDocs](http://libgfapi-python.readthedocs.io/) - -Please follow the [Developer Guide](doc/markdown/dev_guide.md) to -contribute code. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..3d30dd1 --- /dev/null +++ b/README.rst @@ -0,0 +1,11 @@ +libgfapi-python +--------------- + +This is the official python bindings for the +`GlusterFS <http://www.gluster.org/>`_ libgfapi C library interface. + +Complete API reference and documentation can be found at +`ReadTheDocs <http://libgfapi-python.readthedocs.io/>`_. + +Please follow the `Developer Guide <https://github.com/gluster/libgfapi-python/blob/master/doc/markdown/dev_guide.md>`_ to +contribute code. @@ -28,11 +28,15 @@ with open(gfapi_file_path) as f: raise Exception("Couldn't find version in setup.py") +def read(fname): + return open(os.path.join(os.path.dirname(__file__), fname)).read() + + setup( name='gfapi', version=version, description='Python bindings for GlusterFS libgfapi', - long_description='Python bindings for GlusterFS libgfapi', + long_description=read('README.rst'), license='GPLv2 or LGPLv3+', author='Red Hat, Inc.', author_email='gluster-devel@gluster.org', |