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.

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

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

merged 2 commits into from Apr 1, 2022

Conversation

ericwb
Copy link
Member

@ericwb ericwb commented Mar 30, 2022

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

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/

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>
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>
@ericwb ericwb merged commit c166855 into PyCQA:main Apr 1, 2022
@ericwb ericwb deleted the doc_license branch April 1, 2022 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Add licence plus source & tracker links
2 participants