Skip to content

Commit

Permalink
Converting readme to RST for use with pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
carlio committed Dec 1, 2015
1 parent 700f094 commit 9f7357f
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ It brings together the functionality of other Python analysis tools such as
`Pylint <http://docs.pylint.org/>`_,
`pep8 <http://pep8.readthedocs.org/en/latest/>`_,
and `McCabe complexity <https://pypi.python.org/pypi/mccabe>`_.
See the `Supported Tools<http://prospector.landscape.io/en/master/supported_tools.html>`
See the `Supported Tools <http://prospector.landscape.io/en/master/supported_tools.html>`
documentation section for a complete list.

The primary aim of Prospector is to be useful 'out of the box'. A common complaint of other
Expand All @@ -51,16 +51,16 @@ Optional dependencies for Prospector, such as ``pyroma`` can also be installed b


For a list of all of the optional dependencies, see the optional extras section on the ReadTheDocs
page on `supported tools<https://prospector.landscape.io/en/latest/supported_tools.html#optional-extras>`_.
page on `supported tools <https://prospector.landscape.io/en/latest/supported_tools.html#optional-extras>`_.

For more detailed information on installing the tool, see the
`installation section<http://prospector.landscape.io/en/latest/#installation>`_ of the tool's main page
`installation section <http://prospector.landscape.io/en/latest/#installation>`_ of the tool's main page
on ReadTheDocs.

Documentation
-------------

Full `documentation is available at ReadTheDocs<http://prospector.landscape.io>`_.
Full `documentation is available at ReadTheDocs <http://prospector.landscape.io>`_.

Usage
-----
Expand Down Expand Up @@ -92,7 +92,7 @@ Profiles

Prospector is configurable using "profiles". These are composable YAML files with directives to
disable or enable tools or messages. For more information, read
`the documentation about profiles<http://prospector.landscape.io/en/latest/profiles.html>`_.
`the documentation about profiles <http://prospector.landscape.io/en/latest/profiles.html>`_.

If your code uses frameworks and libraries
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 9f7357f

Please sign in to comment.