Adrian Holovaty wrote:
> Is there any other, better way to do it than how it's currently being
> done? It's an imperfect system, but it's "more perfect" than the other
> choice that comes to mind.

Yes, there is a better way to get the right documentation in the hands of
those who use a release:

include the documentation in the frigging release, and make it usable!

Current situation
-----------------

The doc ReST source files are included in the release, but not the HTML,
generated ones. The HTML doc index is not included. Users have to install
docutils, run buildhtml on django/docs, manually point the browser to that
directory, and they get unstyled paged, with no images, and whose links
among them do not work.

How to do it
------------

Use something like the django-documentation app by SmileyChris:

http://smileychris.tactful.co.nz/ramblings/django-documentation/

Let users access the docs from both without and within the admin interface.

The HTML generated files should be included in the release, so that users
do not need to have docutils installed.

Pros
----

The users can easily access the right documentation locally, without
needing access to the web site.

The users do not risk getting to the wrong version of the docs.

The load on djangoproject.com lessens considerably.

Cons
----

None that I can see. It's a no-brainer to me! :-)


-- 
Nicola Larosa - http://www.tekNico.net/

Itamar Shtull-Trauring: reactor.stop() is the way to go, yes. Call it
  when you want the program to start.
Nicola Larosa: To be able to do that you would have to recall John and
  George from heaven, reform the Beatles, pay them a lot to compose
  "Stop Me Down", and use that as the sound theme. -- April 2007



--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To post to this group, send email to django-developers@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-developers?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to