跳转到主要内容

用于sphinx的变更日志渲染器。

项目描述

用于sphinx的变更日志渲染器。

此软件包提供了一种sphinx扩展,旨在简化将变更日志渲染到您的sphinx文档中。

目前,此扩展支持 towncrier 以及包含ReST格式的变更日志文件。

有关更多详细信息,请参阅文档: https://sphinx-changelog.readthedocs.io

发布版本

对于维护者发布此包,请按照以下步骤操作

  1. 更新CHANGELOG.rst

  2. 推送标签

  3. 完成

许可证

本项目的版权归SunPy和OpenAstronomy开发者所有,并按照BSD 3条款许可证的条款进行许可。本软件包基于Openastronomy打包指南,该指南按照BSD 3条款许可证进行许可。有关更多信息,请参阅许可证文件夹。

贡献

我们欢迎贡献!sphinx-changelog是开源的,建立在开源之上,我们希望您能加入我们的社区。

冒充者综合症免责声明:我们需要您的帮助。是的,真的。

您脑海中可能有一个小声音在告诉您,您还没有准备好成为一个开源贡献者;您的技能还不够好,无法做出贡献。您能为这样的项目提供什么可能的帮助呢?

我们向您保证——您脑海中的小声音是错误的。如果您能编写代码,您就可以为开源项目贡献代码。为开源项目做贡献是提高编程技能的绝佳方式。编写完美的代码并不是衡量优秀开发者的标准(这会排除我们所有人!);而是尝试创造东西,犯错误,并从错误中学习。这是我们所有人进步的方式,我们很高兴帮助他人学习。

成为一名开源贡献者并不仅仅是编写代码。您还可以通过编写文档、测试或甚至对项目(以及——是的——对贡献过程)提供反馈来提供帮助。这些贡献中的一些可能对整个项目最有价值,因为您以全新的视角来看待项目,因此可以看到那些经验丰富的贡献者已经忽略的错误和假设。

注意:此免责声明最初由Adrienne LowePyCon演讲编写,并由sphinx-changelog根据其在MetPy项目的README文件中的使用情况进行了改编。

项目详情


下载文件

下载您平台对应的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分布

sphinx_changelog-1.6.0.tar.gz (13.2 kB 查看哈希值)

上传时间 源代码

构建分布

sphinx_changelog-1.6.0-py3-none-any.whl (6.8 kB 查看哈希值)

上传时间 Python 3

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面