Package ivs :: Module makedoc

Module makedoc


Generate epydoc documentation of IvS repository and insert images.

The documentation will be stored in the subdirectory "doc/html" of the IvS root
directory (i.e. where this file is located). If previously generated
documentation exists, it will be overwriten.

The main page of the documentation can be found in "doc/html/index.html".

Updating the documentation is a simple as rerunning the script, you do not need
to delete the results from the previous run.

For more command-line options, see

    $:> python makedoc.py -h

Variables

[hide private]

skip = ['uncertainties', 'lmfit']

parser = argparse.ArgumentParser(description= 'Build IvS Pytho...

args = parser.parse_args()

this_dir = os.path.dirname(os.path.abspath(__file__))

output = subprocess.check_output('git ls-files', shell= True)

alldirs = [ff for ff in alldirs if os.path.splitext(ff) [1]== ...

cmd = 'epydoc --html '+ " ".join(alldirs)+ ' -o doc/html --par...

flag = subprocess.call(cmd, shell= True)

files = sorted(glob.glob('doc/html/*module.html'))

Variables Details

[hide private]

parser

Value:

argparse.ArgumentParser(description= 'Build IvS Python repository docu
mentation')

alldirs

Value:

[ff for ff in alldirs if os.path.splitext(ff) [1]== '.py' and not os.p
ath.basename(ff) [: 4]== 'test']

cmd

Value:

'epydoc --html '+ " ".join(alldirs)+ ' -o doc/html --parse-only --grap
h all {}'.format('-v' if args.verbose else '')