DirectoryLayout defines how the generated html files are organized.
The default implementation uses a flat layout with all files being part
of a single directory.
Methods Summary:
Copy src to dest, if dest doesn't exist yet or is outdated.
scope(
self,
scope =
None)
Return the filename of a scoped name (class or module).
Return the filename for the index of an input file.
Return the filename for the source of an input file.
Return the filename for the details of an input file.
Return the name of the main index file.
Return the name of a special file (tree, etc).
Return the name of a special type of scope file.
Return the name of the module tree index.
Return the name of the index of the given module.
Create a link to the named declaration.
Methods Details:
Copy src to dest, if dest doesn't exist yet or is outdated.
scope(
self,
scope =
None)
Return the filename of a scoped name (class or module).
The default implementation is to join the names with '-' and append
".html". Additionally, special characters are quoted.
Return the filename for the index of an input file.
Default implementation is to join the path with '.', prepend '_file.'
and append '.html'
Return the filename for the source of an input file.
Default implementation is to join the path with '.', prepend '_source.'
and append '.html'
Return the filename for the details of an input file.
Default implementation is to join the path with '.', prepend
'_file_detail.' and append '.html'
Return the name of the main index file. Default is index.html
Return the name of a special file (tree, etc). Default is
_name.html
Return the name of a special type of scope file. Default is to join
the scope with '.' and prepend '.'+name
Return the name of the xref file for the given page
Return the name of the module tree index. Default is
_modules.html
Return the name of the index of the given module. Default is to
join the name with '.', prepend '_module' and append '.html'
Create a link to the named declaration. This method may have to
deal with the directory layout.