A changelog renderer for sphinx.

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

Currently this supports towncrier <https://github.com/twisted/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:

Update CHANGELOG.rst
Push a tag
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 <https://github.com/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 <https://github.com/adriennefriend>_ for a
PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>, and was adapted by
sphinx-changelog based on its use in the README file for the
MetPy project <https://github.com/Unidata/MetPy>.

Dependency	Optional
sphinx	false
towncrier	false
pytest	true
pytest-cov	true
sphinx-automodapi	true

Package profile

sphinx-changelog

Releases

Release table

PyPI Downloads

Dependencies

Details

Project URLs

Dependencies

Package description