Documentation for hlpdoc12, auto-generated by PyRAMID
hlpdoc12 - Create documentation-files in html-format from python-sources.
Author Mischa Takke
E-mail koruptor@hanau.net
Get latest version at koruptor.hanau.net
Version 0.1.4
Created on 04.06.01
Last Changed 04.06.05

hlpdoc12 imports:
sys
re
os

Description:
Usage: pyramid.py sourcefile.py [-o output.html][tags]
Creates html-documentation of the python file(s) given as arguments. for advanced documentation, PyRAMID accepts metatags in form of special comments for functions, classes and modules.
Classes:
Funcdoc:
Classdoc:
Filedoc:

Mainlevel-Functions:
get_docstring(l, start)
get_meta(l, start)
get_includes(l, start)
parse_file(name, lines)
create_html_from_docu(doc)
do_stuff(filename, parsed_files)
main(args)

Class-Despriptions:
class Funcdoc:
class for saving function-information
class Classdoc:
class for saving class-information
class Filedoc:
class for file-information. holds lists of functions and classes.
Mainlevel-Function-Descriptions:
get_docstring(l, start)
get a docstring from a list of strings.
search the list of strings l from startline start. returns a tuple containing the docstring and the last line checked. returns empty string if no docstring was found.
get_meta(l, start)
get meta-tags from a list of strings.
checks the list of strings l for meta-tags. returns a tuple containing the list of meta-tags found and number of last line checked.
get_includes(l, start)
looks for import commands and returns the names of the modules imported
input (list of strings) l: the file to be parsed
input (int) start: at which line to start
returns (list of strings) : the names of the found modules
parse_file(name, lines)
Filedoc parse_file(string name, list lines)
parses a .py-file in form of a list of strings for docstrings and meta-tags, sorted by functions and classes. packs the information into a Filedoc-class and returns this.
input (string) name : the name of the module
input (list of strings) lines : the lines of the source-file
returns (class Filedoc)
create_html_from_docu(doc)
create html-output from a Filedoc-class.
input (class Filedoc) doc : the filedoc, that should be exported into html
returns nothing
do_stuff(filename, parsed_files)
main(args)
main-function.
Opens the files given as arguments, puts the content into lists of strings and passes those to the docu-parser. then passes the information to the create_html-function.
This Documentation was created automatically by PyRAMID (PyRAMID Really Allows Meta-tags In Documentation)