Rename .txt files to match content and add badges.

zopefoundation · Oct 11, 2017 · 072d437 · 072d437
1 parent 3037e42
commit 072d437
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 17 deletions.
diff --git a/CHANGES.txt → CHANGES.rst b/CHANGES.txt → CHANGES.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,8 +1,9 @@
 global-include *.mo
+include *.rst
 include *.txt
 include bootstrap.py
 include buildout.cfg
 include tox.ini
 include .travis.yml
 include .coveragerc
-recursive-include src/martian *.txt *.pt *.py
+recursive-include src/martian *.rst *.pt *.py
diff --git a/README.rst b/README.rst
@@ -0,0 +1,21 @@
+*******
+Martian
+*******
+
+.. image:: https://travis-ci.org/zopefoundation/martian.svg?branch=master
+        :target: https://travis-ci.org/zopefoundation/martian
+
+.. image:: https://readthedocs.org/projects/martian/badge/?version=latest
+        :target: http://martian.readthedocs.org/en/latest/
+        :alt: Documentation Status
+
+.. image:: https://img.shields.io/pypi/v/martian.svg
+        :target: https://pypi.python.org/pypi/martian
+        :alt: PyPI
+
+.. image:: https://img.shields.io/pypi/pyversions/martian.svg
+        :target: https://pypi.python.org/pypi/martian
+        :alt: Python versions
+
+
+A library to grok configuration from Python code.
diff --git a/README.txt b/README.txt
diff --git a/setup.py b/setup.py
@@ -6,11 +6,11 @@ def read(*rnames):
     return open(os.path.join(os.path.dirname(__file__), *rnames)).read()
 
 long_description = (
-    read('README.txt')
+    read('README.rst')
     + '\n' +
-    read('src', 'martian', 'README.txt')
+    read('src', 'martian', 'README.rst')
     + '\n' +
-    read('CHANGES.txt')
+    read('CHANGES.rst')
     + '\n' +
     'Download\n'
     '********\n'

diff --git a/src/martian/README.txt → src/martian/README.rst b/src/martian/README.txt → src/martian/README.rst
diff --git a/src/martian/context.txt → src/martian/context.rst b/src/martian/context.txt → src/martian/context.rst
diff --git a/src/martian/core.txt → src/martian/core.rst b/src/martian/core.txt → src/martian/core.rst
diff --git a/src/martian/directive.txt → src/martian/directive.rst b/src/martian/directive.txt → src/martian/directive.rst
diff --git a/src/martian/edgecase.txt → src/martian/edgecase.rst b/src/martian/edgecase.txt → src/martian/edgecase.rst
diff --git a/src/martian/scan.txt → src/martian/scan.rst b/src/martian/scan.txt → src/martian/scan.rst
diff --git a/...rtian/tests/public_methods_from_class.txt → ...rtian/tests/public_methods_from_class.rst b/...rtian/tests/public_methods_from_class.txt → ...rtian/tests/public_methods_from_class.rst
diff --git a/src/martian/tests/scan_for_classes.txt → src/martian/tests/scan_for_classes.rst b/src/martian/tests/scan_for_classes.txt → src/martian/tests/scan_for_classes.rst
diff --git a/src/martian/tests/test_all.py b/src/martian/tests/test_all.py
@@ -24,34 +24,34 @@
 def test_suite():
     suite = unittest.TestSuite()
     suite.addTests([
-        doctest.DocFileSuite('README.txt',
+        doctest.DocFileSuite('README.rst',
                              package='martian',
                              globs=globs,
                              checker=checker,
                              optionflags=optionflags),
-        doctest.DocFileSuite('scan.txt',
+        doctest.DocFileSuite('scan.rst',
                              package='martian',
                              optionflags=optionflags),
-        doctest.DocFileSuite('directive.txt',
+        doctest.DocFileSuite('directive.rst',
                              package='martian',
                              globs=globs,
                              optionflags=optionflags,
                              encoding='utf-8'),
-        doctest.DocFileSuite('core.txt',
+        doctest.DocFileSuite('core.rst',
                              package='martian',
                              globs=globs,
                              optionflags=optionflags),
-        doctest.DocFileSuite('edgecase.txt',
+        doctest.DocFileSuite('edgecase.rst',
                              package='martian',
                              globs=globs,
                              optionflags=optionflags),
-        doctest.DocFileSuite('scan_for_classes.txt',
+        doctest.DocFileSuite('scan_for_classes.rst',
                              package='martian.tests',
                              optionflags=optionflags),
-        doctest.DocFileSuite('public_methods_from_class.txt',
+        doctest.DocFileSuite('public_methods_from_class.rst',
                              package='martian.tests',
                              optionflags=optionflags),
-        doctest.DocFileSuite('context.txt',
+        doctest.DocFileSuite('context.rst',
                              package='martian',
                              globs=globs,
                              optionflags=optionflags),