search

bitprophet / releases

A powerful Sphinx changelog-generating extension.
http://releases.readthedocs.io/
BSD 2-Clause "Simplified" License
176 stars 41 forks source link

generating changelog fails if there are comments at the top of the file #13

Closed Autoplectic closed 10 years ago

Autoplectic commented 10 years ago

if changelog.rst has anything above the title, generating docs will fail. you should be able to add comments or other non-visible directives to the top of the file.

bitprophet commented 10 years ago

To be fair this is documented behavior, see 2nd bullet point here: http://releases.readthedocs.org/en/latest/usage.html#usage

That said, I'd accept a PR changing this so it preserves elements around the expected bulleted list.