[refs #24] Fixing some formatting problems with the output created by…

… readthedocs
prospector-dev · Oct 2, 2014 · 8d98e1c · 8d98e1c
1 parent 95550a4
commit 8d98e1c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -22,7 +22,7 @@ About
 
 Prospector is a tool to analyse Python code and output information about errors, potential problems, convention violations and complexity.
 
-It brings together the functionality of other Python analysis tools such as `Pylint`_, `pep8`_, and `McCabe complexity`_ . See the 'Supported Tools' section below for a complete list.
+It brings together the functionality of other Python analysis tools such as `Pylint`_, `pep8`_, and `McCabe complexity`_ . See the :doc:`Supported Tools<supported_tools>` section for a complete list.
 
 The primary aim of Prospector is to be useful 'out of the box'. A common complaint of other Python analysis tools is that it takes a long time to filter through which errors are relevant or interesting to your own coding style. Prospector provides some default profiles, which hopefully will provide a good starting point and be useful straight away. 
 
@@ -33,7 +33,7 @@ You can install using ``pip``::
 
     pip install prospector
 
-To install optional dependencies such as ``pyroma``:
+To install optional dependencies such as ``pyroma``::
 
     pip install prospector[with_pyroma]
 
@@ -53,7 +53,7 @@ This will output a list of messages pointing out potential problems or errors, f
         L5:0 ToolBase: pylint - R0922
         Abstract class is only referenced 1 times
 
-Read about the full list of options in the :doc:`usage <usage>`_ section.
+Read about the full list of options in the :doc:`usage <usage>` section.
 
 
 License

diff --git a/docs/supported_tools.rst b/docs/supported_tools.rst
@@ -115,5 +115,5 @@ about unused code that is in fact used.
 To install and use::
 
     pip install prospector[with_vulture]
-	prospector --with-tool vulture
+    prospector --with-tool vulture
     
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -21,17 +21,17 @@ The default output format of ``prospector`` is designed to be human readable. Yo
 +=============+============================================================================+
 | ``emacs``   | Support for emacs compilation output mode, see `issue_16`_.                |
 +-------------+----------------------------------------------------------------------------+
-| ``grouped`` | Similar to ``text``, but groups all message on the same line together      |
-|             | rather than having a separate entry per message.                           |
+| ``grouped`` | | Similar to ``text``, but groups all message on the same line together    |
+|             | | rather than having a separate entry per message.                         |
 +-------------+----------------------------------------------------------------------------+
-| ``pylint``  | Produces output in the same style as ``pylint --parseable``. This should   |
-|             | allow ``prospector`` to be used as a drop-in replacement for any tools     |
-|             | which parse ``pylint`` output. The one minor difference is that the output |
-|             | includes the name of the tool which generated the error as well as the     |
-|             | error code.                                                                |
+| ``pylint``  | | Produces output in the same style as ``pylint --parseable``. This should |
+|             | | allow ``prospector`` to be used as a drop-in replacement for any tools   |
+|             | | which parse ``pylint`` output. The one minor difference is that the      |
+|             | | output includes the name of the tool which generated the error as well   |
+|             | | as the error code.                                                       |
 +-------------+----------------------------------------------------------------------------+
-| ``json``    | Produces a structured, parseable output of the messages and summary. See   |
-|             | below for more information about the structure.                            |
+| ``json``    | | Produces a structured, parseable output of the messages and summary. See |
+|             | | below for more information about the structure.                          |
 +-------------+----------------------------------------------------------------------------+
 | ``yaml``    | Same as JSON except produces YAML output.                                  |
 +-------------+----------------------------------------------------------------------------+