Skip to content

Commit

Permalink
Fix README.rst for pypi.
Browse files Browse the repository at this point in the history
 - Add warehouse as a test dependency and its readme check to `make lint`.
 - Replace repeated named links in README with anonymous links.

See also https://bitbucket.org/pypa/pypi/issue/239/rst-broken#comment-None.
  • Loading branch information
jmchilton committed Feb 16, 2015
1 parent 6ae65d7 commit 3499ca0
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Makefile
Expand Up @@ -32,7 +32,7 @@ clean-test:
rm -fr htmlcov/

lint:
flake8 --max-complexity 11 planemo tests
flake8 --max-complexity 11 planemo tests && python setup.py check -r -s

test:
python setup.py test
Expand Down
6 changes: 3 additions & 3 deletions README.rst
Expand Up @@ -74,7 +74,7 @@ or (like all available commands) be accessed by passing it ``--help``.::
...

Once tools are syntically correct - it is time to test. The ``test``
`command <http://planemo.readthedocs.org/en/latest/commands.html#test-command>`_
`command <http://planemo.readthedocs.org/en/latest/commands.html#test-command>`__
can be used to test a tool or directory of tools.::

% planemo test --galaxy_root=../galaxy-central randomlines.xml
Expand Down Expand Up @@ -102,7 +102,7 @@ example of such a report for Tophat.

Once tools have been linted and tested - the tools can be viewed in a
Galaxy interface using the ``serve`` (``s``) `command
<http://planemo.readthedocs.org/en/latest/commands.html#serve-command>`_.::
<http://planemo.readthedocs.org/en/latest/commands.html#serve-command>`__.::

% planemo serve

Expand All @@ -116,7 +116,7 @@ requests. `Travis CI <http://travis-ci.org/>`_ is a service providing free
testing and deep integration with GitHub_.

The ``travis_init`` `command
<http://planemo.readthedocs.org/en/latest/commands.html#travis_init-command>`_
<http://planemo.readthedocs.org/en/latest/commands.html#travis_init-command>`__
will bootstrap a project with files to ease contineous inegration of tools
using a Planemo driven approach inspired by this great `blog post
<http://bit.ly/gxtravisci>`_ by `Peter Cock <https://github.com/peterjc>`_.
Expand Down
3 changes: 3 additions & 0 deletions dev-requirements.txt
@@ -1,6 +1,9 @@
# For dev
sphinx

# Used to check readme.
warehouse

# Used for code checking.
pyflakes
flake8
Expand Down

0 comments on commit 3499ca0

Please sign in to comment.