Provides a Hierarichial structure to a ReSTDocument You can write to it similar to as you can to a ReSTDocument but has an innate structure for more orginaztion and abstraction. :param name: The name of the document :param section_names: A list of sections to be inc
(self, name, section_names=None, target='man', context=None)
| 127 | |
| 128 | class DocumentStructure(ReSTDocument): |
| 129 | def __init__(self, name, section_names=None, target='man', context=None): |
| 130 | """Provides a Hierarichial structure to a ReSTDocument |
| 131 | |
| 132 | You can write to it similar to as you can to a ReSTDocument but |
| 133 | has an innate structure for more orginaztion and abstraction. |
| 134 | |
| 135 | :param name: The name of the document |
| 136 | :param section_names: A list of sections to be included |
| 137 | in the document. |
| 138 | :param target: The target documentation of the Document structure |
| 139 | :param context: A dictionary of data to store with the structure. These |
| 140 | are only stored per section not the entire structure. |
| 141 | """ |
| 142 | super(DocumentStructure, self).__init__(target=target) |
| 143 | self._name = name |
| 144 | self._structure = OrderedDict() |
| 145 | self._path = [self._name] |
| 146 | self._context = {} |
| 147 | if context is not None: |
| 148 | self._context = context |
| 149 | if section_names is not None: |
| 150 | self._generate_structure(section_names) |
| 151 | |
| 152 | @property |
| 153 | def name(self): |
nothing calls this directly
no test coverage detected