diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 5876cecf2655ddd1264b13997082b9e3af25bc5a..d1ea106d80df171cdfe146eb3c513c792cfe647d 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 43a8f2413ac698be518bddfce023c8de834c71bc..bbc7ab460f7f8b4ab9b1b2d0ba261621b3825502 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 b79542f1663cb2d807c408f8f6630b40e72e277e..0000000000000000000000000000000000000000 --- 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 0000000000000000000000000000000000000000..e04d97c819947998384617363255ed63305ff980 --- /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 ff5ba422f11690ef897adca9ce19c152dacb7f9b..46e9abedd56edfbb5d58ccddf1d9a3d643c34555 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()