Function main

docs/driversdoc.py:323–366

()

    return packages, failed_packages

def main():
    print('\nGenerating documentation for drivers ...')
    packages, failed_packages = list_packages(drivers)
    class opts:
        pass
    opts.dryrun = False
    opts.destdir = os.path.join(path.dirname(__file__), 'drivers')
    if not os.path.exists(opts.destdir):
        os.mkdir(opts.destdir)
    opts.force = True
    opts.suffix = 'rst'
    fname = os.path.join(opts.destdir, 'index.rst')
    with open(fname, 'w') as fp:
        fp.write('.. _drivers:\n\n')
        fp.write(format_heading(0, 'Drivers'))
        fp.write('\n')
        fp.write('.. toctree::\n')
        fp.write('   :hidden:\n')
        fp.write('   :glob:\n')
        fp.write('\n')
        fp.write('   *\n')
        last = ''
        for key in sorted(packages.keys()):
            if key == 'legacy':
                continue
            try:
                company = company_parser(packages[key].__doc__).strip()
            except Exception as e:
                company = key.split('.')[-2]
            if key.split('.')[-1] != last:
                last = key.split('.')[-1]
                #fp.write(format_heading(2, '`{} <{}>`'.format(company, key)))
                fp.write('\n\n:mod:`{} <{}>`\n\n'.format(company, key))
                #fp.write('- :class:`{} <{}.{}>`\n'.format(company, key, key))
                create_module_file(drivers.__name__, last, opts)

            module = packages[key]
            fp.write(list_drivers(key, module))

        if failed_packages:
            fp.write(format_heading(1, 'Failed to generate the docs for the following subpackages'))
            fp.write('\n')
            for key in sorted(failed_packages):
                fp.write('- {}\n'.format(key))

if __name__ == '__main__':
    main()