Skip to main content

A changelog renderer for sphinx.

Project description

A changelog renderer for sphinx.

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-0.1rc3.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

sphinx_changelog-0.1rc3-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_changelog-0.1rc3.tar.gz.

File metadata

  • Download URL: sphinx_changelog-0.1rc3.tar.gz
  • Upload date:
  • Size: 11.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

File hashes

Hashes for sphinx_changelog-0.1rc3.tar.gz
Algorithm Hash digest
SHA256 1b2c3c59007ce1ee55d35ef7781ee337e2f45b8a59b89386b266dece0c70a1d9
MD5 e26ceb159906af9581ca7d70f0a1a93f
BLAKE2b-256 8bddfd94523e3edf398ba51edfc39a75b3e1084118543766befda1ad99a3d391

See more details on using hashes here.

File details

Details for the file sphinx_changelog-0.1rc3-py3-none-any.whl.

File metadata

  • Download URL: sphinx_changelog-0.1rc3-py3-none-any.whl
  • Upload date:
  • Size: 6.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/54.0.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7

File hashes

Hashes for sphinx_changelog-0.1rc3-py3-none-any.whl
Algorithm Hash digest
SHA256 cc4e7c9e310e378ab77b5e0a3ab1604326016243763e32650fab8ddf81009a43
MD5 1ac7a70e3cb977725e829e2e07b6d9b5
BLAKE2b-256 c535d663aa665f0453849030495a8cb6599b7761fff22dfa1b557718699be04d

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