ford.pagetree module

class ford.pagetree.PageNode(md, path, output_dir, proj_copy_subdir, parent, encoding='utf-8')

Bases: object

Object representing a page in a tree of pages and subpages.

property path

property url

ford.pagetree.get_page_tree(topdir, proj_copy_subdir, output_dir, md, settings, progress=None, parent=None, encoding='utf-8')

ford.pagetree.is_excluded_dir(path, settings)

Should path be excluded from the pagetree?

Return type:

bool