From b81f222fe2d0970158ed14e12c21a654c9b77043 Mon Sep 17 00:00:00 2001
From: Paul McCarthy <pauldmccarthy@gmail.com>
Date: Tue, 6 Jun 2017 23:08:32 +0100
Subject: [PATCH] README.md moved to README.rst, because pypi doesn't support
md. Xvfb install tweak
---
.gitlab-ci.yml | 2 +-
MANIFEST.in | 1 -
README.md | 42 ------------------------------------------
README.rst | 43 +++++++++++++++++++++++++++++++++++++++++++
setup.py | 2 +-
5 files changed, 45 insertions(+), 45 deletions(-)
delete mode 100644 README.md
create mode 100644 README.rst
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 5876cecf2..d1ea106d8 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -212,7 +212,7 @@ variables:
# Linux builds for wxPython are currently
# not on pypi, but are available at this
# url.
- - apt-get install xvfb
+ - apt-get install -y xvfb
- pip install -f https://wxpython.org/Phoenix/release-extras/linux/gtk3/debian-8/ wxpython
# All other deps can be installed as normal
diff --git a/MANIFEST.in b/MANIFEST.in
index 43a8f2413..bbc7ab460 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,6 +1,5 @@
include LICENSE
include COPYRIGHT
-include README.md
include requirements.txt
include pytest.ini
recursive-include doc *
diff --git a/README.md b/README.md
deleted file mode 100644
index b79542f16..000000000
--- a/README.md
+++ /dev/null
@@ -1,42 +0,0 @@
-fslpy
-=====
-
-
-The `fslpy` project is a [FSL](http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/)
-programming library written in Python. It is used by
-[FSLeyes](https://git.fmrib.ox.ac.uk/paulmc/fsleyes/).
-
-
-Dependencies
-------------
-
-
-All of the dependencies of `fslpy` are listed in the
-[requirements.txt](requirements.txt) file. Some `fslpy` modules require
-[wxPython](http://www.wxpython.org) 3.0.2.0.
-
-
-Documentation
--------------
-
-`fslpy` is documented using [sphinx](http://http://sphinx-doc.org/). You can
-build the API documentation by running:
-
- python setup.py doc
-
-The HTML documentation will be generated and saved in the `doc/html/` directory.
-
-
-If you are interested in contributing to `fslpy`, check out the [contributing
-guide](doc/contributing.rst).
-
-
-Tests
------
-
-Run the test suite via:
-
- python setup.py test
-
-A test report will be generated at `report.html`, and a code coverage report
-will be generated in `htmlcov/`.
diff --git a/README.rst b/README.rst
new file mode 100644
index 000000000..e04d97c81
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,43 @@
+fslpy
+=====
+
+
+The ``fslpy`` project is a `FSL <http://fsl.fmrib.ox.ac.uk/fsl/fslwiki/>`_
+programming library written in Python. It is used by `FSLeyes
+<https://git.fmrib.ox.ac.uk/paulmc/fsleyes/>`_.
+
+
+Dependencies
+------------
+
+
+All of the dependencies of ``fslpy`` are listed in the `requirements.txt
+<requirements.txt>`_ file. Some ``fslpy`` modules require `wxPython
+<http://www.wxpython.org>`_ 3.0.2.0 or higher.
+
+
+Documentation
+-------------
+
+``fslpy`` is documented using `sphinx <http://http://sphinx-doc.org/>`_. You
+can build the API documentation by running::
+
+ python setup.py doc
+
+The HTML documentation will be generated and saved in the ``doc/html/``
+directory.
+
+
+If you are interested in contributing to ``fslpy``, check out the
+`contributing guide <doc/contributing.rst>`_.
+
+
+Tests
+-----
+
+Run the test suite via::
+
+ python setup.py test
+
+A test report will be generated at ``report.html``, and a code coverage report
+will be generated in ``htmlcov/``.
diff --git a/setup.py b/setup.py
index ff5ba422f..46e9abedd 100644
--- a/setup.py
+++ b/setup.py
@@ -37,7 +37,7 @@ with open(op.join(basedir, "fsl", "version.py")) as f:
break
version = version['__version__']
-with open(op.join(basedir, 'README.md'), 'rt') as f:
+with open(op.join(basedir, 'README.rst'), 'rt') as f:
readme = f.read()
--
GitLab