generates a structured file system instead of a flat one
Operations Summary: | |
__init__(self) [Source] | |
nameOfScope(self, scope) Return the filename of a scoped name (class or module). [Source] | |
nameOfFileIndex(self, file) Return the filename for the index of an input file. [Source] | |
nameOfFileSource(self, file) Return the filename for the source of an input file. [Source] | |
nameOfFileDetails(self, file) Return the filename for the details of an input file. [Source] | |
nameOfIndex(self) Return the name of the main index file. [Source] | |
nameOfSpecial(self, name) Return the name of a special file (tree, etc). [Source] | |
nameOfScopedSpecial(self, name, scope, ext = ".html") Return the name of a special type of scope file [Source] | |
nameOfModuleTree(self) Return the name of the module tree index [Source] | |
nameOfModuleIndex(self, scope) Return the name of the index of the given module [Source] |
Operations Inherited from FileLayout | |
copyFile, _checkMain, _stripFilename, link |
Operation Details: |
Return the filename of a scoped name (class or module). One subdirectory per scope
Return the filename for the index of an input file. The base_dir config option is used. Default implementation is to join the path with '-', prepend "_file-" and append ".html"
Return the filename for the source of an input file. The base_dir config option is used. Default implementation is to join the path with '-', prepend "_source-" and append ".html"
Return the filename for the details of an input file. The base_dir config option is used. Returns the filename nested in the FileDetails directory and with .html appended.