Open ncoghlan opened 2 weeks ago
I just set this up myself, and it seemed like it would be generally useful enough to be worth mentioning somewhere in the scriv docs:
changelog.d
toctree
:hidden:
glob:
.. toctree::
For example, have this in pyproject.toml:
pyproject.toml
[tool.scriv] fragment_directory = "docs/changelog.d"
and this in the Sphinx page that includes the CHANGELOG.rst file:
CHANGELOG.rst
.. Syntax check the changelog fragments .. toctree:: :hidden: :glob: changelog.d/* .. Include the scriv-generated changelog details .. include:: ../CHANGELOG.rst
This should also work for markdown fragments (assuming Sphinx is set up to render markdown files)
I just set this up myself, and it seemed like it would be generally useful enough to be worth mentioning somewhere in the scriv docs:
changelog.d
folder under your Sphinx docs folder (sotoctree
directives can access it):hidden:
+ :glob:
.. toctree::
directive somehow that renders the unreleased fragments without linking themFor example, have this in
pyproject.toml
:and this in the Sphinx page that includes the
CHANGELOG.rst
file:This should also work for markdown fragments (assuming Sphinx is set up to render markdown files)