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:
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 <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>`_.
Raw data
{
"_id": null,
"home_page": "https://openastronomy.org",
"name": "sphinx-changelog",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "SunPy and OpenAstronomy Developers",
"author_email": "stuart@cadair.com",
"download_url": "https://files.pythonhosted.org/packages/c6/d2/7993bb750f87e2d063aa824e659eaf135d77892633bbff86f22d22573dfd/sphinx_changelog-1.5.0.tar.gz",
"platform": null,
"description": "A changelog renderer for sphinx.\n--------------------------------\n\nThis package provides a sphinx extension designed to facilitate rendering changelogs into your sphinx documentation.\n\nCurrently this supports `towncrier <https://github.com/twisted/towncrier>`__ and inclusion of a ReST changelog file.\n\nFor more details see the documentation: https://sphinx-changelog.readthedocs.io\n\nDoing a Release\n---------------\n\nFor maintainers releasing this package, follow these steps:\n\n1. Update CHANGELOG.rst\n2. Push a tag\n3. Profit\n\nLicense\n-------\n\nThis project is Copyright (c) SunPy and OpenAstronomy Developers and licensed under\nthe terms of the BSD 3-Clause license. This package is based upon\nthe `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_\nwhich is licensed under the BSD 3-clause licence. See the licenses folder for\nmore information.\n\n\nContributing\n------------\n\nWe love contributions! sphinx-changelog is open source,\nbuilt on open source, and we'd love to have you hang out in our community.\n\n**Imposter syndrome disclaimer**: We want your help. No, really.\n\nThere may be a little voice inside your head that is telling you that you're not\nready to be an open source contributor; that your skills aren't nearly good\nenough to contribute. What could you possibly offer a project like this one?\n\nWe assure you - the little voice in your head is wrong. If you can write code at\nall, you can contribute code to open source. Contributing to open source\nprojects is a fantastic way to advance one's coding skills. Writing perfect code\nisn't the measure of a good developer (that would disqualify all of us!); it's\ntrying to create something, making mistakes, and learning from those\nmistakes. That's how we all improve, and we are happy to help others learn.\n\nBeing an open source contributor doesn't just mean writing code, either. You can\nhelp out by writing documentation, tests, or even giving feedback about the\nproject (and yes - that includes giving feedback about the contribution\nprocess). Some of these contributions may be the most valuable to the project as\na whole, because you're coming to the project with fresh eyes, so you can see\nthe errors and assumptions that seasoned contributors have glossed over.\n\nNote: This disclaimer was originally written by\n`Adrienne Lowe <https://github.com/adriennefriend>`_ for a\n`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`_, and was adapted by\nsphinx-changelog based on its use in the README file for the\n`MetPy project <https://github.com/Unidata/MetPy>`_.\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "A changelog renderer for sphinx.",
"version": "1.5.0",
"project_urls": {
"Homepage": "https://openastronomy.org"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd1bdddbb7c116aebb56f70e1d3c8e7c2ee0dd9197dea51d6895951b7ae9e345",
"md5": "487b8b4c46ab050fdd399678e4212f75",
"sha256": "8c95d411a039e4c701e83e4a24e153b95a457329c181ddea2e9ec6ca2ed9d51e"
},
"downloads": -1,
"filename": "sphinx_changelog-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "487b8b4c46ab050fdd399678e4212f75",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6887,
"upload_time": "2024-01-26T10:11:24",
"upload_time_iso_8601": "2024-01-26T10:11:24.608904Z",
"url": "https://files.pythonhosted.org/packages/dd/1b/dddbb7c116aebb56f70e1d3c8e7c2ee0dd9197dea51d6895951b7ae9e345/sphinx_changelog-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c6d27993bb750f87e2d063aa824e659eaf135d77892633bbff86f22d22573dfd",
"md5": "f91356131c4b0aa5e6a135b01cd70811",
"sha256": "023dd60c34bc1b992e87f3e697d1be1c26b9428f8af5327fe1553fd3e9d6fb0b"
},
"downloads": -1,
"filename": "sphinx_changelog-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "f91356131c4b0aa5e6a135b01cd70811",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13245,
"upload_time": "2024-01-26T10:11:26",
"upload_time_iso_8601": "2024-01-26T10:11:26.316306Z",
"url": "https://files.pythonhosted.org/packages/c6/d2/7993bb750f87e2d063aa824e659eaf135d77892633bbff86f22d22573dfd/sphinx_changelog-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-26 10:11:26",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-changelog"
}
JSON