#528: Add a documentation generator that creates a PDF or HTML files locally
----------------------------+-----------------------------------------------
Reporter: anonymous | Owner: Harkins
Status: assigned | Component: Documentation
Version: | Resolution:
Keywords: sprintsept14 | Stage: Accepted
Has_patch: 1 | Needs_docs: 1
Needs_tests: 0 | Needs_better_patch: 1
----------------------------+-----------------------------------------------
Changes (by mtredinnick):
* needs_better_patch: 0 => 1
* stage: Ready for checkin => Accepted
* needs_docs: 0 => 1
Comment:
This isn't ready to check in.
* There should be practically no executable code at the top level. In
other words, importing the file should not execute it. At least a
{{{main()}}} function and {{{if __name__ == '__main__':}}} guard are
required.
* The imports should conform to PEP 8 style guidelines.
* If you don't have docutils installed (which will be noticable in the
import section), a helpful error message would be good, since docutils
don't come by default with Python.
If somebody wants to take this further, it's probably worth checking in
with Adrian (see comment 7) to find out where he's up.
--
Ticket URL: <http://code.djangoproject.com/ticket/528#comment:15>
Django Code <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
-~----------~----~----~----~------~----~------~--~---
