Re: ASCII or PDF version of docs?
On Tue, Mar 28, 2006 at 11:11:58AM -0600, Adrian Holovaty wrote: > Alternatively (or maybe additionally), we could have a separate > downloadable tarball of all the docs in HTML format, with all the CSS > and images. I would prefer not to include all of that in the main > Django distribution, because it's a lot of cruft. Regardless of whether you include all the html/css or not, or the ability to create it after you un-tar a release package, the key point I was trying to make is: The portion of the online doc covering the models (at http://www.djangoproject.com/documentation/models/ ) is a critical and absolutely necessary part of the documentation as it now exists. The examples are not merely "examples", they include some documentation that does not appear anywhere else in the docs. Making the html/css or even pdf a separate download component is fine, but the docs as part of the base tar file of Django must include all the docs -- and that must include the example docs too. ---OR--- the docs need to be rewriten to bring the documentation aspects of all the examples into the "docs" another way. Thanks -- Glenn Tenney --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django users" group. To post to this group, send email to django-users@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-users -~--~~~~--~~--~--~---
Re: ASCII or PDF version of docs?
> > I maintain that all of the online docs need to be in the tar file... > > It would be nice and clean to take the code that converts the ReST > docs into HTML, and the unit tests into HTML, and bundle that with > Django along with a simple view that displays it, converting the docs > on the fly -- so you can run a local Django instance to get the docs > in HTML. +1 on this one. The last time I've tried building the docs I've run into some problems (some files gave errors where I wasn't sure whether my setup was to blame) and the style information is missing. This would hopefully also help to keep the docs more up to date as more people would find inconsistencies when using the trunk or branches. Arthur --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django users" group. To post to this group, send email to django-users@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-users -~--~~~~--~~--~--~---
Re: ASCII or PDF version of docs?
On 3/28/06, Glenn Tenney <[EMAIL PROTECTED]> wrote: > Are these examples helpful? Certainly, but... > > (a) they need to be in a different and much more obvious location... oh, > in the docs directory would be a start. > > (b) they are not the complete text of what's online and the parts that > are missing are in fact critical to one trying to learn Django. > > I maintain that all of the online docs need to be in the tar file... It would be nice and clean to take the code that converts the ReST docs into HTML, and the unit tests into HTML, and bundle that with Django along with a simple view that displays it, converting the docs on the fly -- so you can run a local Django instance to get the docs in HTML. Alternatively (or maybe additionally), we could have a separate downloadable tarball of all the docs in HTML format, with all the CSS and images. I would prefer not to include all of that in the main Django distribution, because it's a lot of cruft. Adrian -- Adrian Holovaty holovaty.com | djangoproject.com --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django users" group. To post to this group, send email to django-users@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-users -~--~~~~--~~--~--~---
Re: ASCII or PDF version of docs?
On 3/24/06, Glenn Tenney <[EMAIL PROTECTED]> wrote: > On Fri, Mar 24, 2006 at 07:45:18PM -0600, James Bennett wrote: > > Every time you download Django, you get a complete copy of the latest > > version of the documentation, in ASCII format. > > As I've noted on one of the doc pages on the web, that's not quite > correct... You don't get all of the model examples -- and some of the > needed documentation is in the example pages surrounding the actual > examples. i.e. you don't get any of the doc at > http://www.djangoproject.com/documentation/models/ That's incorrect; you do indeed get the model examples. Although it's not obvious, they're in the directory tests/testapp/models directory of the Django distribution. The model examples are generated automatically from the unit tests. Adrian -- Adrian Holovaty holovaty.com | djangoproject.com --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django users" group. To post to this group, send email to django-users@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-users -~--~~~~--~~--~--~---
ASCII or PDF version of docs?
Is there an ASCII or PDF version of the documentation? Specially installation, tutorial and overview. Tried to print them, but any line that is long, gets cutoff when printing from my FreeBSD desktop at work.. Will try a windows machine at home.. but it would be nice if the documentation was available in other formats. Worst case will try an HTML -> ASCII tool and then format. If there isn't PDF available yet, would it be helpfull if I made PDFs for overview, installation and tutorial? --~--~-~--~~~---~--~~ You received this message because you are subscribed to the Google Groups "Django users" group. To post to this group, send email to django-users@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-users -~--~~~~--~~--~--~---
