Hacker News new | past | comments | ask | show | jobs | submit login

It's true. But building from source might be a pain for some people, especially newbies like me.



> But building from source might be a pain for some people, especially newbies like me.

It's really not hard, and it's using a tool you should start using as soon as you start "serious" Python projects: Sphinx.

Building the doc from source is pretty much trivial on Unix-type systems (OSX, Linux, BSD, whatever)

* Get the django source, either tarball or source control

* Install sphinx

* Go to the root of your Django install

* `make -C docs [format...]` where format is any set of valid sphinx output formats: html, dirhtml, singlehtml, htmlhelp, qthelp, devhelp, epub, latex, latexpdf, text or man

You compiled documentation will be in the `_build/$format` directory, for each format you're building (you can build all of them). The latexpdf target requires that `pdflatex` be installed and available.


If Django makes too many things official, installing it will become a pain for some people, especially newbies.

They have to walk a careful line in that regard, and I think they made the right call on offline docs.


I don't get it, what does providing a pdf or zipped html files have to do with installing?

Flask does this[0], and so does ReadTheDocs.

It isn't clear to me what is stopping Django from providing precompiled docs, bandwidth costs?

[0] http://flask.pocoo.org/docs/


You know, I'm not sure what I was thinking when I wrote that. There's no real great reason to avoid doing it other than download size, and I doubt that's a huge issue. Right now I think they're just doing releases as a .tar.gz archive of the checkout files. That'd mean an extra "build" step at release time, but that's probably trivial to automate.

That said, the source text files for the documentation are included, and whatever markup format they use (reStructuredText?) is relatively legible. HTML docs would be better, though.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: