pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-06 21:16:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs - add badge instructions to quickstart guide

Browse source 
Show user how to add the Flake8 badge to their project.

These local URLs would need to be replaced
with a hosted https version
once the image is actually hosted somewhere.
This commit is contained in:
Dave Schaefer 2019-12-30 21:13:02 -07:00
parent d1187d4409
commit bdcf2f8c27
1 changed files with 17 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/source/index.rst
View file

@ -69,6 +69,23 @@ Alternatively, if you want to *ignore* only one specific warning or error:
Please read our user guide for more information about how to use and configure
|Flake8|.
Flake8 Project Badge
--------------------
If you'd like to add a |Flake8| badge to your project to show off your use of
|Flake8|, add the following to your README.rst:
::
.. image:: docs/source/img/linter-flake8-green.svg
:target: https://gitlab.com/pycqa/flake8
or README.md:
::
[![linter: flake8](docs/source/img/linter-flake8-green.svg)](https://gitlab.com/pycqa/flake8)
FAQ and Glossary
================