Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add license and contributing links to docs #867

Merged
merged 2 commits into from
Apr 1, 2022
Merged

Add license and contributing links to docs #867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f43e6e
Fix for build breaks in format job
ericwb Apr 1, 2022
0327809
Add license and contributing links to docs
ericwb Mar 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ repos:
- id: reorder-python-imports
args: [--application-directories, '.:src', --py37-plus]
- repo: https://github.com/psf/black
rev: 21.10b0
rev: 22.3.0
hooks:
- id: black
args: [--line-length=79, --target-version=py37]
Expand Down
2 changes: 1 addition & 1 deletion doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
=======
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't believe this is what they wanted and even if it is, I'm strongly against this solution

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would you prefer just linking to an existing license file?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That seems fair but I think it would be enough to state we're apache licensed without directly linking. No project I know of duplicates the text or looks to the license

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was inspired by this example: https://pycodestyle.pycqa.org/en/latest/


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>`_