From c1668558fcd87c03357da4b47143f4c57acfcb58 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Fri, 1 Apr 2022 12:13:14 -0700 Subject: [PATCH] Add license and contributing links to docs (#867) * 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 https://github.com/psf/black/issues/2964 Signed-off-by: Eric Brown * 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 --- doc/source/conf.py | 2 +- doc/source/index.rst | 22 +++++++++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index b129ec46c..6e376759d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -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 diff --git a/doc/source/index.rst b/doc/source/index.rst index fd1dbe14e..64638cf9f 100644 --- a/doc/source/index.rst +++ b/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:: @@ -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 `_