#26020: Standardize restructed text header convention in docs
------------------------------------------------+------------------------
Reporter: timgraham | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Accepted | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 1
UI/UX: 0 |
------------------------------------------------+------------------------
It would be nice to fix some inconsistencies in our heading styles and
document the convention in `docs/internals/contributing/writing-
documentation.txt`. To avoid changing everything, I think we should
deviate slightly from [http://documentation-style-guide-
sphinx.readthedocs.org/en/latest/style-guide.html#headings the sphinx
style guide] and use something like this (where "four" and below are
subject to change depending on what documents already use):
{{{
===
One
===
Two
===
Three
-----
Four
~~~~
Five
^^^^
}}}
I attached a patch to get started. Note that any top level `.. _` links
can be removed. These are replaced with `:doc:`.
--
Ticket URL: <https://code.djangoproject.com/ticket/26020>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/052.2d7c9c5dc80b0b20a90d5da14a1a26fa%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
