#9645: Documentation generated with docutils 0.4 has broken css due to broken
ids
------------------------------------+---------------------------------------
Reporter: waltercruz | Owner: ramiro
Status: new | Milestone:
Component: Documentation | Version: SVN
Resolution: | Keywords:
Stage: Accepted | Has_patch: 1
Needs_docs: 0 | Needs_tests: 0
Needs_better_patch: 0 |
------------------------------------+---------------------------------------
Changes (by ramiro):
* has_patch: 0 => 1
* stage: Unreviewed => Accepted
Comment:
Replying to [comment:7 ramiro]:
> I cat reproduce this with a recent Sphinx trunk checkout plus docutils
0.5.
I meant ''I CAN reproduce this...''. BTW Sphinx 0.5 was released today.
I'm attaching a patch that tries to ensure that the doc building process:
1. Creates the `"s-"`-prefixed section id names as per Django original
styling requirements. Example:
{{{
<div class="section" id="s-getting-help">
}}}
2. Creates and preserves the anchor names associated the section titles
so the docs.djangoproject.com URLs don't change (links pointing to
internal sections already in the wild will keep working). It does so by
means of an `id` attribute, either in an empty {{{<span>}}} tag or in the
{{{<hN>}}} tag itself. Examples:
(Sphinx 0.5, docutils 0.5):
{{{
<span id="getting-help"></span><h2>Getting help<a class="headerlink" href
="#getting-help" title="Permalink to this headline">¶</a></h2>
}}}
(Sphinx 0.4.2, docutils 0.5):
{{{
<h2 id="getting-help">Getting help<a class="headerlink" href="#getting-
help" title="Permalink to this headline">¶</a></h2>
}}}
3. Both requirements above are met also with locally generated HTML
documentation so styling and navigation don't get broken.
I have tested it in the six possible scenarios: Sphinx versions 0.4.2,
0.4.3 & 0.5 and docutils versions 0.4 & 0,5. Please test it in your local
environment.
--
Ticket URL: <http://code.djangoproject.com/ticket/9645#comment:8>
Django <http://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 post to this group, send email to django-updates@googlegroups.com
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en
-~----------~----~----~----~------~----~------~--~---
