#8179: most cross-references in sphinx-generated HTML are wrong
------------------------------------+---------------------------------------
Reporter: niccl | Owner: nobody
Status: new | Milestone:
Component: Documentation | Version: SVN
Resolution: | Keywords:
Stage: Accepted | Has_patch: 0
Needs_docs: 0 | Needs_tests: 0
Needs_better_patch: 0 |
------------------------------------+---------------------------------------
Comment (by markb):
I'm a noob to django but think this bug is quite important because it
effectively renders the local documentation almost useless. Most links
just don't work.
Also, I am not sure if this is related but the sphinx built html includes
a search facility but the reported links also never work. So again, the
search facility is useless.
A (arguably unrelated) issue is that I think the docs/ directory should
include a basic README.txt file explaining how to build the local docs and
where/how to read them. The docs is the first place a noob goes but with a
README.txt he can't even bootstrap himself. The README.txt may just say to
type "make" and explain the options are little clearer, e.g. make web "to
make files usable by Sphinx.web" but what the heck is Sphinx.web,
particularly to a noob? README should also say to where/how to read the
docs, e.g. $BROWSER docs/_build/html/index.html. All of this is presently
very obscure.
--
Ticket URL: <http://code.djangoproject.com/ticket/8179#comment:3>
Django Code <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 [email protected]
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
-~----------~----~----~----~------~----~------~--~---
