The Django documentation is already included in code base with Django and
anybody is welcome to submit patches for them.  If you do a checkout of
Django, there will be a "docs" directory there.  Inside there is the full
documentation source in reStructuredText.  If you'd like a local HTML or PDF
version of the docs you can simply install sphinx[1] on your machine and
build the docs like any other sphinx project.

If your interested in learning more I'd recommend that you read the "How the
Django Documentation Works"[2] page as well as "Contributing to Django"[3].

____________________________
Sean O'Connor
http://seanoc.com

[1] http://sphinx.pocoo.org/
<http://sphinx.pocoo.org/>[2]
http://docs.djangoproject.com/en/1.1/internals/documentation/#internals-documentation
<http://docs.djangoproject.com/en/1.1/internals/documentation/#internals-documentation>
[3]
http://docs.djangoproject.com/en/1.1/internals/contributing/#internals-contributing


On Fri, Mar 5, 2010 at 11:35 AM, stherrien <shawntherr...@gmail.com> wrote:

> What I'm suggesting is that we setup something to allow everyone to
> improve the docs with help from the core django group. I think this
> would be very helpful to everyone. if one of the core group would like
> to help us get setup to do this it would be great. maybe if they setup
> a repository with the current online docs online so we can add updates
> as we do with django itself.
>
> On Mar 5, 11:20 am, stherrien <shawntherr...@gmail.com> wrote:
> > Exactly my point docs need to be more organization to be constructive
> > for django users.
> >
> > On Mar 5, 11:05 am, Jared Forsyth <ja...@jaredforsyth.com> wrote:
> >
> > > To be honest I am quicker to just go to django's source code rather
> than the
> > > docs, as often I can find what I need there, and the docs aren't (imo)
> > > organized enough to provide much of an advantage.
> >
> > > On Fri, Mar 5, 2010 at 8:46 AM, stherrien <shawntherr...@gmail.com>
> wrote:
> > > > Hi all,
> >
> > > > I have a request that django documentation show the import locations
> > > > for classes like in other well formed docs found on the web showing
> > > > the users where the classes can be found for import. I think this
> > > > would be handy for newer users and experienced users finding
> something
> > > > new. Documentation on the site is different from page to page. Take
> > > > for instance the file object doc page in django doesn't tell the user
> > > > where this can be imported which requires you to dig into the python
> > > > help pages to try and find it. which is "from django.core.files.base
> > > > import File". it would be nice to show this consistently across the
> > > > site. I would be happy to help make this happen.
> >
> > > > -shawn
> >
> > > > --
> > > > You received this message because you are subscribed to the Google
> Groups
> > > > "Django developers" group.
> > > > To post to this group, send email to
> django-develop...@googlegroups.com.
> > > > To unsubscribe from this group, send email to
> > > > django-developers+unsubscr...@googlegroups.com<django-developers%2bunsubscr...@googlegroups.com>
> <django-developers%2bunsubscr...@googlegroups.com<django-developers%252bunsubscr...@googlegroups.com>
> >
> > > > .
> > > > For more options, visit this group at
> > > >http://groups.google.com/group/django-developers?hl=en.
>
> --
> You received this message because you are subscribed to the Google Groups
> "Django developers" group.
> To post to this group, send email to django-develop...@googlegroups.com.
> To unsubscribe from this group, send email to
> django-developers+unsubscr...@googlegroups.com<django-developers%2bunsubscr...@googlegroups.com>
> .
> For more options, visit this group at
> http://groups.google.com/group/django-developers?hl=en.
>
>

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to django-develop...@googlegroups.com.
To unsubscribe from this group, send email to 
django-developers+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/django-developers?hl=en.

Reply via email to