-
Notifications
You must be signed in to change notification settings - Fork 11
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
docs, mkdocs: fix domain, title caps #15
Conversation
Signed-off-by: William Woodruff <william@trailofbits.com>
(NB: I've also made an effort to retain the same |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm generally fine with this - as it does make it explicit and allows us to control the order.
@ewdurbin any objections?
# Terms of use | ||
# Terms of Use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: if the case here changes, we'll need an update over here:
https://github.com/pypi/warehouse/blob/83b0c6de32c174208f3a65c061bd8fcc8983213c/warehouse/routes.py#L62
(and associated test case) as mkdocs/rtd are case sensitive.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, I'll make a PR there as well!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Signed-off-by: William Woodruff <william@trailofbits.com>
maybe add a note to README "how to add a page to nav"? |
Signed-off-by: William Woodruff <william@trailofbits.com>
Done with 934e64e! |
Fixes the sentence-casing of domains (and some small title inconsistencies) by adding an explicit
nav
hierarchy.Downside: requires files to be tracked in the
nav
hierarchy as well before they get rendered. This downside is shared by the PyPI user + dev docs currently, and is a known limitation of mkdocs.Before:
After:
CC @miketheman, who made me see these and activated my compulsion to fix them 🙂