bandit/doc/source/index.rst
Tim Kelsey 0b7574f5bf Adding docs for new style blacklist calls
Implements: blueprint bandit-docs
Change-Id: I243652e60752234dfc569dbaa1f7f5cc5eabc083
2016-02-10 10:17:17 +00:00

28 lines
659 B
ReStructuredText

Welcome to Bandit's developer documentation!
============================================
Bandit is a tool designed to find common security issues in Python code. To do
this, Bandit processes each file, builds an AST from it, and runs appropriate
plugins against the AST nodes. Once Bandit has finished scanning all the files,
it generates a report.
This documentation is generated by the Sphinx toolkit and lives in the source
tree.
Getting Started
===============
.. toctree::
:maxdepth: 1
config
plugins/index
blacklists/index
formatters/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`