#26020 closed Cleanup/optimization (fixed)
Standardize restructed text header convention in docs
Reported by: | Tim Graham | Owned by: | Elif T. Kuş |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Accepted | |
Has patch: | yes | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | yes | UI/UX: | no |
Description
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 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:
.
Attachments (1)
Change History (17)
by , 9 years ago
Attachment: | headers.diff added |
---|
comment:1 by , 9 years ago
comment:2 by , 9 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:3 by , 9 years ago
@timgraham
Note that any top level .. _ links can be removed. These are replaced with :doc:.
Does that mean that I should replace ".. _glossary:
" with ":doc:`glossary`
"?
comment:4 by , 9 years ago
Not quite; you can remove .. _glossary:
and if there are any links pointing to it, you'll update them to use :doc:
instead of :ref:
.
comment:6 by , 9 years ago
Here is my pull request https://github.com/django/django/pull/5923
It's my first pull request to the django repo.
I was not clear to me whether I should also change second level headings. Some files where I left the second level heading as it is (which was in the third level heading format):
faq\*.txt
howto\custom-template-tags.txt
howto\error-reporting.txt
howto\writing-migrations.txt
internals\mailing-lists.txt
internals\contributing\writing-code\working-with-git.txt
intro\install.txt
I can change them if you think they need to be changed.
comment:7 by , 9 years ago
Has patch: | set |
---|
comment:8 by , 9 years ago
Has patch: | unset |
---|
comment:9 by , 9 years ago
Has patch: | set |
---|
Resubmitted the pull request: https://github.com/django/django/pull/5924
The above comments still hold.
comment:11 by , 9 years ago
Patch needs improvement: | set |
---|
comment:14 by , 9 years ago
Patch needs improvement: | unset |
---|
Go ahead, no one's going to stop you :-)