Provides a Hierarichial structure to a ReSTDocument You can write to it similiar 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 in
(self, name, section_names=None, target='man', context=None)
| 105 | |
| 106 | class DocumentStructure(ReSTDocument): |
| 107 | def __init__(self, name, section_names=None, target='man', context=None): |
| 108 | """Provides a Hierarichial structure to a ReSTDocument |
| 109 | |
| 110 | You can write to it similiar to as you can to a ReSTDocument but |
| 111 | has an innate structure for more orginaztion and abstraction. |
| 112 | |
| 113 | :param name: The name of the document |
| 114 | :param section_names: A list of sections to be included |
| 115 | in the document. |
| 116 | :param target: The target documentation of the Document structure |
| 117 | :param context: A dictionary of data to store with the strucuture. These |
| 118 | are only stored per section not the entire structure. |
| 119 | """ |
| 120 | super().__init__(target=target) |
| 121 | self._name = name |
| 122 | self._structure = OrderedDict() |
| 123 | self._path = [self._name] |
| 124 | self._context = {} |
| 125 | if context is not None: |
| 126 | self._context = context |
| 127 | if section_names is not None: |
| 128 | self._generate_structure(section_names) |
| 129 | |
| 130 | @property |
| 131 | def name(self): |
nothing calls this directly
no test coverage detected