use markdown default template in markdown docs#546
use markdown default template in markdown docs#546adiroiban merged 2 commits intotwisted:trunkfrom EFord36:markdown-use-default-template
Conversation
| python: "3.11" | ||
|
|
||
| python: | ||
| system_packages: False |
There was a problem hiding this comment.
this was removed from RTD 2023-08-29
https://blog.readthedocs.com/drop-support-system-packages/
We need this change to build the docs
|
I looked into my problem with I removed the issue I was having from the description for clarity - preserving below for transparency: check_newsfragment issueOne problem at the moment - when I run `nox -e pre_commit check_newsfragment` I get a failure on |
There was a problem hiding this comment.
Thanks. It looks very good.
https://towncrier--546.org.readthedocs.build/en/546/markdown.html
I hope that in the future we can also have a standard directory name for these files.
I see now that towncrier uses newsfragments but this documentation is suggesting changelog.d
I prefer something like release-notes/123.fix :)
For the other issue, is best to open a separate ticket, if you want o work on it.
The idea is that towncrie is expected to be used by developers, so there isn't much effort into making the errors "user friendly"
but of course, we can and should improve the error reporting.
Description
Closes #545
Uses the default markdown templates introduced in #483 in the markdown docs rather than specifying a custom template.
One option for resolving #545 - thought I'd provide a PR as it was simple, but happy if you want to resolve in a different way (e.g. an explicit block in the docs discussing the default markdown template vs the custom one currently used).
Checklist
src/towncrier/newsfragments/. Describe yourchange and include important information. Your change will be included in the public release notes.
docs/tutorial.rstis still up-to-date.docs/cli.rstreflects those changes.docs/configuration.rstreflects those changes.