Esempio n. 1
0
    def _print_package_rst(self, package):
        self._print_header(package)
        # Body / Package Comment
        self._append('%s\n' % package.name)
        if package.revision is not None:
            self._append('Revision: {0}\n'.format(package.revision))
        if package.comment is not None:
            self._append(package.comment)

        # Adding augment references
        augments = set()
        self._collect_all_augments(package.stmt, augments)
        if len(augments) > 0:
            self.ctx.bline()
            if len(augments) == 1:
                for aug_class in augments:
                    line = '\nThis module contains augment: ' + get_class_crossref_tag(
                        aug_class.qn(), aug_class, self.lang) + '\n'
                    self._append(line)
            else:
                line = '\nThis module contains the following augments:\n'
                self._append(line)
                for aug_class in augments:
                    line = '\t - ' + get_class_crossref_tag(
                        aug_class.qn(), aug_class, self.lang) + '\n'
                    self._append(line)
Esempio n. 2
0
    def _print_package_rst(self, package):
        self._print_header(package)
        # Body / Package Comment
        self._append('%s\n' % package.name)
        if package.revision is not None:
            self._append('Revision: {0}\n'.format(package.revision))
        if package.comment is not None:
            self._append(package.comment)

        # Adding augment references
        augments = set()
        self._collect_all_augments(package.stmt, augments)
        if len(augments) > 0:
            self.ctx.bline()
            if len(augments) == 1:
                for aug_class in augments:
                    line = '\nThis module contains augment: ' + get_class_crossref_tag(aug_class.qn(), aug_class, self.lang) + '\n'
                    self._append(line)
            else:
                line = '\nThis module contains the following augments:\n'
                self._append(line)
                for aug_class in augments:
                    line = '\t - ' + get_class_crossref_tag(aug_class.qn(), aug_class, self.lang) + '\n'
                    self._append(line)
Esempio n. 3
0
    def _get_class_hierarchy(self, clazz):
        parent_list = []
        parent = clazz
        while isinstance(parent, Class):
            parent_list.append(parent)
            parent = parent.owner

        clazz_hierarchy = ['Class Hierarchy \:']
        if len(parent_list) > 0:
            for parent in reversed(parent_list):
                if not clazz_hierarchy[0][-1:] == ':':
                    clazz_hierarchy.append(' \>')

                tag = get_class_crossref_tag(parent.name, parent, self.lang)
                clazz_hierarchy.append(tag)

            return ''.join(clazz_hierarchy)
        else:
            return None
Esempio n. 4
0
    def _get_class_hierarchy(self, clazz):
        parent_list = []
        parent = clazz
        while isinstance(parent, Class):
            parent_list.append(parent)
            parent = parent.owner

        clazz_hierarchy = ['Class Hierarchy \:']
        if len(parent_list) > 0:
            for parent in reversed(parent_list):
                if not clazz_hierarchy[0][-1:] == ':':
                    clazz_hierarchy.append(' \>')

                tag = get_class_crossref_tag(parent.name, parent, self.lang)
                clazz_hierarchy.append(tag)

            return ''.join(clazz_hierarchy)
        else:
            return None