Skip to content

Commit

Permalink
Add license and contributing links to docs (#867)
Browse files Browse the repository at this point in the history
* Fix for build breaks in format job

This change bumps the version of Black in use to fix the errors
seen coming out of the format build step.

See psf/black#2964

Signed-off-by: Eric Brown <browne@vmware.com>

* Add license and contributing links to docs

As requested in issue #617, include the license in a section of
the main page of the readthedocs site. Also included are links
to the source code repository and the issue tracker.

Closes #617

Signed-off-by: Eric Brown <browne@vmware.com>
  • Loading branch information
ericwb committed Apr 1, 2022
1 parent 7c39add commit c166855
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
2 changes: 1 addition & 1 deletion doc/source/conf.py
Expand Up @@ -26,7 +26,7 @@

# General information about the project.
project = "Bandit"
copyright = "2016, Bandit Developers"
copyright = "2022, Bandit Developers"

# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
Expand Down
22 changes: 17 additions & 5 deletions doc/source/index.rst
@@ -1,14 +1,11 @@
Welcome to the Bandit documentation!
====================================
Welcome to Bandit
=================

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.

Using and Extending Bandit
==========================
.. toctree::
Expand All @@ -21,9 +18,24 @@ Using and Extending Bandit
formatters/index
faq

Contributing
============

* `Source code`_
* `Issue tracker`_

.. _`Source code`: https://github.com/PyCQA/bandit
.. _`Issue tracker`: https://github.com/PyCQA/bandit/issues

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

License
=======

The ``bandit`` library is provided under the terms and conditions of the
`Apache License 2.0 <https://www.apache.org/licenses/LICENSE-2.0.txt>`_

0 comments on commit c166855

Please sign in to comment.