Support outputting a changelog in reStructuredText
See original GitHub issueDescription
As the title states, it would be convenient for use with sphinx documentation to be able to output the changelog in rst
format.
Possible Solution
This seems like it should be a configuration option versus a commandline option.
Issue Analytics
- State:
- Created 2 years ago
- Reactions:1
- Comments:7 (7 by maintainers)
Top Results From Across the Web
sphinx_rtd_theme/changelog.rst at master - GitHub
This release adds upper bounds to direct dependencies Sphinx and docutils which will safeguard from mixing with possibly incompatible future versions of Sphinx...
Read more >reStructuredText Primer - Sphinx documentation
reStructuredText is the default plaintext markup language used by Sphinx. ... the given size will only be respected for output channels that support...
Read more >reStructuredText Markup Specification - Docutils - SourceForge
Escaped whitespace characters are removed from the output document together with the escaping backslash. This allows for character-level inline markup. In URI ...
Read more >reStructuredText tool support - Stack Overflow
POT output lacks the helpful error messages displayed by the ROR (and generated by docutils ). Java - JRst. JRst is a Java...
Read more >Sphinx's reStructuredText primer - Wiser 0.1 documentation
Remember that consecutive blank lines will be ignored in the HTML output. ... The reStructuredText markup supports two basic types of tables.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
That makes a lot of sense and would simplify things a lot. Either generate all or latest, right?. If you need specific range you can use
cz changelog 0.2.0..0.4.0
and that would cover all the cases. Is a trade-off over more manual work (sometimes), vs making it more flexible to support other formats.One good thing about the detection of the title is that you can have a bunch of text before the changelog (like the recommendation of keepachangelog before start listing the changes). How could we achieve that?
One solution could be to only generate the changelog for the latest release by default. Then, if someone wants to generate a changelog for all releases, have that be a command option. Users should only ever be generating a changelog for more than the most recent version of their project once, at the time of adoption of this tool.
If the user only wanted a changelog for the last X number of versions, then it would be an easy cut/paste job from the command generated changelog. Again, this scenario should only ever happen once in a project’s lifetime, so not a big deal.
It doesn’t seem you’d need to be inspecting any changelog files with this all or one generation approach, and then could theoretically support any number of file types, given the changelog output itself is configurable.