Enforce to cleanup RST errors

PyPI is enforcing to not have syntax errors in package
descriptors. The README file is used as project's description.
According to the official documentation[1], PyPI supports three
different formats (plain text, reStructureText and Markdown).

This change changes the format of the README file to Markdown and
reports syntax errors in documentation. These errors need to be
fixed before a new release can be done.

[1] https://packaging.python.org/guides/making-a-pypi-friendly-readme/

Change-Id: Ia96882528df8a371cc8a89a7d9d74233c4d1b1de
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
(cherry picked from commit a60ef68c25)

README.md

@@ -0,0 +1,12 @@
+# Tricircleclient
+
+Python bindings to the OpenStack Tricircle API
+
+This is a client for OpenStack Tricircle API providing a Python API (using the
+**tricircleclient** module) and a Command Line Interface (installed as the
+**tricircle** command). Each implements the entire OpenStack Tricircle API.
+
+* Free software: Apache license
+* [Documentation](https://docs.openstack.org/python-tricircleclient/latest/)
+* [Source](http://git.openstack.org/cgit/openstack/python-tricircleclient)
+* [Bugs](http://bugs.launchpad.net/python-tricircleclient)

README.rst

@@ -1,15 +0,0 @@
-===============
-tricircleclient
-===============
-
-Python bindings to the OpenStack Tricircle API
-
-This is a client for OpenStack Tricircle API. There's :doc:`a Python API
-<api>` (the :mod:`tricircleclient` module), and a :doc:`command-line script
-<shell>` (installed as :program:`tricircle`). Each implements the entire
-OpenStack Tricircle API.
-
-* Free software: Apache license
-* Documentation: https://docs.openstack.org/python-tricircleclient/latest/
-* Source: http://git.openstack.org/cgit/openstack/python-tricircleclient
-* Bugs: http://bugs.launchpad.net/python-tricircleclient

doc/source/api.rst

@@ -1,5 +1,5 @@
 The :mod:`tricircleclient` Python API
-====================================
+=====================================
 
 .. module:: tricircleclient
    :synopsis: A client for the Tricircle API.

doc/source/index.rst

@@ -12,8 +12,6 @@ This is a client for OpenStack Tricircle API. There's :doc:`a Python API <api>`
 
     __ https://docs.openstack.org/tricircle/latest/
 
-.. _Tricircle: https://docs.openstack.org/tricircle/latest/
-
 Contents:
 
 .. toctree::

setup.cfg

@@ -2,7 +2,7 @@
 name = tricircleclient
 summary = Python client library for Tricircle
 description-file =
-    README.rst
+    README.md
 author = OpenStack
 author-email = openstack-dev@lists.openstack.org
 home-page = https://docs.openstack.org/python-tricircleclient/latest/

tox.ini

@@ -27,8 +27,17 @@ whitelist_externals = sh
 commands = oslo_debug_helper -t tricircleclient/tests/unit {posargs}
 
 [testenv:pep8]
-deps = hacking<0.13,>=0.12
-commands = flake8
+basepython = python3
+deps =
+    hacking<0.13,>=0.12
+    rstcheck
+commands =
+    flake8
+    bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
+         -name \*.rst -type f            \
+         -print0 | xargs -0 rstcheck --ignore-directive automodule,module \
+         --ignore-roles mod"
+whitelist_externals = bash
 
 [testenv:venv]
 commands = {posargs}