#20935: ePub documentation not valid
-------------------------------------+-------------------------------------
Reporter: mabdullah | Owner: Fredrik
| Malmfors
Type: Bug | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Carlton Gibson):
* status: assigned => closed
* resolution: => fixed
Comment:
OK, decision time. Thanks for your follow-up work here David.
Testing with `Sphinx==2.4.3`, we're down to just the SVG errors, and these
TOC ordering warnings.
* The SVG we can leave for now. There are no reports of actual bad
rendering. SVG v2 allows removing the DTD, from the SVGs which causes the
errors. We **could** do that manually but, without any real reports of
rendering issues, I'm inclined to wait it out.
* The order is more tricky: Looking at the PR, we can't really use the
`rubric` approach as it removes elements that we **want** in the TOC.
> Another solution would be to add the content on the current CBV index
page to a sub page. Could call 'class based view quick start guide', as
there is already a sub page called introduction.
I think this would be step back too. The current page is good. It would be
replaced with a empty page with just the TOC there... — I don't see that's
a win.
The rule is under review:
> The previous rule is under review and its severity may change in a
future release. See the discussion at https://github.com/w3c/publ-epub-
revision/issues/1283
It may become a SHOULD. I've left a comment supporting that, and providing
a link back here so folks can see the lengths we've gone to.
At this point I'm going to suggest this ticket is fixed, and I want to
thank everyone who had put time into it. These validity issues often take
a lot of effort. They don't always seem important. But they ensure content
is accessible across the widest range of devices, to the widest range of
people. That's noble work.
--
Ticket URL: <https://code.djangoproject.com/ticket/20935#comment:25>
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 django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/067.750ba8470d33c0ef855d08c289e13d7f%40djangoproject.com.
