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

Section headers #5

Open
jeanas opened this issue Feb 3, 2022 · 2 comments
Open

Section headers #5

jeanas opened this issue Feb 3, 2022 · 2 comments

Comments

@jeanas
Copy link
Contributor

jeanas commented Feb 3, 2022

reST requires section headers to be at least as long as the title. This is invalid:

Section title
============

Also, overline and underline must also be the same length. This is equally invalid:

##############
Title
#############

Sphinx is able to warn about the first, but not about the second. In the latter case, the title just gets dropped completely (which surprises me somewhat). At any rate, it'd be nice if we could check for it as it's a somewhat easy mistake to make.

@jeanas
Copy link
Contributor Author

jeanas commented Feb 23, 2022

@JulienPalard Would you be OK with adding Docutils as a dependency? It's needed for its helper docutils.utils.column_width in order to take special Unicode widths like with combining characters and other weird Unicode stuff (if we want to care about that). It's going to be pulled in by Sphinx if we start using it anyway.

@JulienPalard
Copy link
Collaborator

In one hand it feels overkill to depend on docutils for ~3 lines of code, on the other hand it's going to be pulled anyway by Sphinx so OK.

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

2 participants