diff --git a/docs/Makefile b/docs/Makefile index 1421d362..a98fb515 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -9,7 +9,7 @@ BUILDDIR = _build # User-friendly check for sphinx-build ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://www.sphinx-doc.org/) endif # Internal variables. diff --git a/docs/contrib.rst b/docs/contrib.rst index bfa8e27d..2c8cba81 100644 --- a/docs/contrib.rst +++ b/docs/contrib.rst @@ -38,7 +38,7 @@ handling the output of other tools. However, please do run them before submittin nosetests tests/ Prospector targets Python 2.7, 3.3, 3.4, 3.5 and 3.6. You can use `tox`_ to test this locally, -and all tests are run on `travis.org`_. +and all tests are run on `travis-ci.org`_. -.. _tox: https://tox.readthedocs.org/en/latest/ -.. _travis.org: https://travis-ci.org/landscapeio/prospector +.. _tox: https://tox.readthedocs.io/en/latest/ +.. _travis-ci.org: https://travis-ci.org/landscapeio/prospector diff --git a/docs/index.rst b/docs/index.rst index b532e4a1..24d8516f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -24,8 +24,8 @@ 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 `_, +`Pylint `_, +`pep8 `_, and `McCabe complexity `_. See the :doc:`Supported Tools` section for a complete list. diff --git a/docs/profiles.rst b/docs/profiles.rst index 22bc26dc..1024b171 100644 --- a/docs/profiles.rst +++ b/docs/profiles.rst @@ -307,4 +307,4 @@ The available options are: +-----------+------------------+----------------------------------------------+ -.. _pylint options: http://docs.pylint.org/features.html#options +.. _pylint options: https://pylint.readthedocs.io/en/latest/user_guide/run.html diff --git a/docs/supported_tools.rst b/docs/supported_tools.rst index 205db2df..67560836 100644 --- a/docs/supported_tools.rst +++ b/docs/supported_tools.rst @@ -26,17 +26,17 @@ To run the default tools but turn off one or two defaults:: Defaults -------- -`Pylint `_ +`Pylint `_ ````````````````````````````````` Pylint is the most comprehensive static analysis tool for Python. It is extremely thorough and is the source of most messages that prospector outputs. -`pep8.py `_ +`pep8.py `_ ``````````````````````````````````````````````````` ``pep8.py`` is a simple tool to warn about violations of the -`PEP8 style guide `_. It produces +`PEP8 style guide `_. It produces messages for any divergence from the style guide. Prospector's concept of :doc:`strictness ` turns off various warnings @@ -64,7 +64,7 @@ than pylint, but also not as thorough. `mccabe `_ ``````````````````````````````````````````````` -`McCabe or cyclomatic complexity `_ is +`McCabe or cyclomatic complexity `_ is a measurement of how many paths there are in a given function or method. It measures how complicated your functions are, and warns if they reach a certain threshold. Methods that are too complex are prone to logic errors, and should be refactored to a series of smaller