Help, Documentation tools
Software Documentation is an important part of software engineering that isoften overlooked. Types of documentation include: * Architecture - Architectural overview of software; including relations to an environment, construction principles to be used in design and technical documentation, etc. * Design - The design of software components.* Technical - Documentation of code, algorithms, interfaces, APIs.* End User - Manuals for the end-user.* Operator - Manuals for the systems administrator.
From : en.wikipedia.org/wiki/Software_Documentation
PyManual
PyManual is a Python module and program to extract documentation strings from Python functions, classes, and methods and transform them into LaTeX, PDF, HTML, or HTB (wxWidgets help viewer) documents. PyManual intends to provide comprehensive and compact presentations of the compiled documentation strings that support the process of software development as well as serve as a manual of the released implementations. Therefore, PyManual particularly concentrates on text structure elements for long documentation strings and uses a HTML pages appropiate for help file viewer like wxWidgets helpview or the Microsoft help compiler. The HTML output is completed by an extensive table if contents and index file (index.hhp, index.hhc and index.hhc).
visit
PyManual
PyManual was visited : 37 times
Loading .....