Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it easy to configure custom underlines #63

Closed
njsmith opened this issue Aug 3, 2017 · 0 comments
Closed

Make it easy to configure custom underlines #63

njsmith opened this issue Aug 3, 2017 · 0 comments

Comments

@njsmith
Copy link
Contributor

njsmith commented Aug 3, 2017

Sphinx is picky about headline underlines: it requires a consistent hierarchy throughout your docs. So if you keep your changelog as part of your manual, it's important that the headlines towncrier generates be at the appropriate level to "fit in". (This is especially true when migrating an existing project to towncrier.)

Currently this is impossible. You do part of it by using a custom template, but (a) this requires copy/pasting the complex default template file into your project just to change two characters, which is unfriendly, and (b) the topline still uses a hardcoded === underline, and there's no way to configure this at all.

It would be nice if there were a configuration option like underlines = ["=", "-", "~"] that would let the user specify the desired headline underline hierarchy in a straightforward way.

njsmith added a commit to njsmith/towncrier that referenced this issue Aug 3, 2017
njsmith added a commit to njsmith/towncrier that referenced this issue Aug 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant