def _print_toctree(self, elements, is_package=False): self._append('.. toctree::') self.ctx.lvl_inc() self._append(':maxdepth: 1\n') if not is_package: elements.reverse() for elem in elements: if isinstance(elem, Class) or isinstance(elem, Enum): self._append('%s <%s>' % (elem.name, get_rst_file_name(elem))) else: for elem in elements: self._append('%s <%s>' % (elem.name, get_rst_file_name(elem))) self._append('') self.ctx.lvl_dec()
def _print_toctree_section(self, elements, title): if len(elements) == 0: return if len(title) > 0 and self.lang != 'go': self._append('**{}**\n'.format(title)) self._append('.. toctree::') self.ctx.lvl_inc() self._append(':maxdepth: 1\n') for elem in elements: self._append('%s <%s>' % (elem.name, get_rst_file_name(elem))) self._append('') self.ctx.lvl_dec()
def _write_toctree(self, named_element): self.ctx.writeln('.. toctree::') self.ctx.lvl_inc() lines = [] lines.append(':maxdepth: 1\n') owned_elements = named_element.owned_elements owned_elements.reverse() for c in owned_elements: if isinstance(c, Class) or isinstance(c, Enum): lines.append('%s <%s>' % (c.name, get_rst_file_name(c))) lines.append('') self.ctx.writelns(lines) self.ctx.lvl_dec()
def _print_toctree_section(self, elements, keyword): if len(elements) == 0: return if len(keyword) > 0: title = self._get_toctree_section_title(keyword) self._append('**{}**\n'.format(title)) self._append('.. toctree::') self.ctx.lvl_inc() self._append(':maxdepth: 1\n') for elem in elements: self._append('%s <%s>' % (elem.name, get_rst_file_name(elem))) self._append('') self.ctx.lvl_dec()
def print_ydk_models_rst(self, packages): lines = [] title = 'YDK Model API' lines.append(title) lines.append('=' * len(title)) lines.append('') lines.append('.. toctree::') self.ctx.writelns(lines) self.ctx.lvl_inc() lines = [] lines.append(':maxdepth: 1\n') for package in packages: line = '%s <%s>' % (package.name, get_rst_file_name(package)) lines.append(line) self.ctx.writelns(lines) self.ctx.lvl_dec()
def get_python_module_documentation_file_name(path, named_element): return '%s/%s.rst' % (path, get_rst_file_name(named_element))
def get_cpp_doc_file_name(path, named_element): return '%s/%s.rst' % (path, get_rst_file_name(named_element))
def get_go_doc_file_name(path, named_element): return '%s/%s.rst' % (path, get_rst_file_name(named_element))
def get_python_rst_file_name(path, named_element): return '%s/%s.rst' % (path, get_rst_file_name(named_element))