Skip to main content

A changelog renderer for sphinx.

Project description

A changelog renderer for sphinx.

This package provides a sphinx extension designed to facilitate rendering changelogs into your sphinx documentation.

Currently this supports towncrier and inclusion of a ReST changelog file.

For more details see the documentation: https://sphinx-changelog.readthedocs.io

Doing a Release

For maintainers releasing this package, follow these steps:

  1. Update CHANGELOG.rst

  2. Push a tag

  3. Profit

License

This project is Copyright (c) SunPy and OpenAstronomy Developers and licensed under the terms of the BSD 3-Clause license. This package is based upon the Openastronomy packaging guide which is licensed under the BSD 3-clause licence. See the licenses folder for more information.

Contributing

We love contributions! sphinx-changelog is open source, built on open source, and we’d love to have you hang out in our community.

Imposter syndrome disclaimer: We want your help. No, really.

There may be a little voice inside your head that is telling you that you’re not ready to be an open source contributor; that your skills aren’t nearly good enough to contribute. What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong. If you can write code at all, you can contribute code to open source. Contributing to open source projects is a fantastic way to advance one’s coding skills. Writing perfect code isn’t the measure of a good developer (that would disqualify all of us!); it’s trying to create something, making mistakes, and learning from those mistakes. That’s how we all improve, and we are happy to help others learn.

Being an open source contributor doesn’t just mean writing code, either. You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process). Some of these contributions may be the most valuable to the project as a whole, because you’re coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

Note: This disclaimer was originally written by Adrienne Lowe for a PyCon talk, and was adapted by sphinx-changelog based on its use in the README file for the MetPy project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_changelog-1.3.0.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

sphinx_changelog-1.3.0-py3-none-any.whl (6.8 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_changelog-1.3.0.tar.gz.

File metadata

  • Download URL: sphinx_changelog-1.3.0.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for sphinx_changelog-1.3.0.tar.gz
Algorithm Hash digest
SHA256 97b4966f644df4e8176e9fbb650c2f9c852ca314a1cbe1c82711b56b8db03d08
MD5 fd484014c2192b63395d93a16fc1aae4
BLAKE2b-256 8ce07b98a5936c76d6d8f95b64907df0b56a8d5eeabf65034ea4befb01aa2248

See more details on using hashes here.

File details

Details for the file sphinx_changelog-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_changelog-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e3b713f8b41a42d94ccbfcc3bb1198bd36819259ec2a3f1dcf26fbe628bafdd9
MD5 13111747ef9027e5378fb3c22861ec72
BLAKE2b-256 857835e44a0a60d200b9211a7384bd4d8337d6909158eda68936f27b8f7da5bc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page