#11152: Some classes missing in documentation
------------------------------------+---------------------------------------
Reporter: ben | Owner: nobody
Status: new | Milestone:
Component: Documentation | Version: 1.0
Resolution: | Keywords: autodoc intersphinx
Stage: Accepted | Has_patch: 0
Needs_docs: 0 | Needs_tests: 0
Needs_better_patch: 0 |
------------------------------------+---------------------------------------
Changes (by russellm):
* needs_better_patch: => 0
* stage: Unreviewed => Accepted
* needs_tests: => 0
* needs_docs: => 0
Comment:
The answer is a little of column A, and a little of column B.
Django's docs were originally just raw Restructured Text. Just prior to
v1.0, we made the conversion to Sphinx. However, as you can imagine, there
was a lot of conversion to do. On top of that, the old ReST docs didn't
have indexes, contents pages, etc. As a result, there are several problems
hanging around. To take your class reference issue as an example:
- There are old-style ReST references to classes, rather than sphinx-
annotated :class: references
- There are missing index entries (i.e., putting the anchor in the docs
where the class is defined).
- There is documentation that is just plain missing for some classes.
There is a
[http://docs.djangoproject.com/en/dev/internals/documentation/#todo TODO
listing work that needs to be done on the docs].
This problem isn't a simple as a single ticket - There are lots of
individual issues to be resolved, and through a process of gradual
improvement, many patches will be required. I'll leave this ticket open as
a placeholder for the specific "missing class references" problem. Please
open new tickets (with patches) if you want to work on another class of
problem.
--
Ticket URL: <http://code.djangoproject.com/ticket/11152#comment:1>
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 [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
-~----------~----~----~----~------~----~------~--~---
