Changes between Version 4 and Version 5 of ReviewingDocumentation


Ignore:
Timestamp:
06/26/2010 07:22:48 AM (8 years ago)
Author:
jesstess
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ReviewingDocumentation

    v4 v5  
    7373If everything looks good, submit a patch as described [wiki:TwistedDevelopment#SubmittingaPatch here]
    7474
     75=== Editing man pages ===
     76
     77Twisted man pages live in doc/<subproject>/man. The man pages are lore'd as part of a release to generate html files, so if you're reviewing man pages you should make sure they generate valid html through lore. The easiest way to do this is to steal from twisted.python._release. To, for example, generate xhtml from the troff files in doc/core/man:
     78
     79{{{
     80from twisted.python.filepath import FilePath
     81dir = FilePath('doc/core/man')
     82from twisted.python._release import ManBuilder
     83m = ManBuilder()
     84m.build(dir)
     85}}}
     86
     87you can then lore the resulting xhtml files to generate html.
     88
    7589=== More ===
    7690see also [wiki:DocumentationAnalysis DocumentationAnalysis] from an old Twisted documentation sprint.