• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

Python autosummary.Autosummary类代码示例

原作者: [db:作者] 来自: [db:来源] 收藏 邀请

本文整理汇总了Python中sphinx.ext.autosummary.Autosummary的典型用法代码示例。如果您正苦于以下问题:Python Autosummary类的具体用法?Python Autosummary怎么用?Python Autosummary使用的例子?那么恭喜您, 这里精选的类代码示例或许可以为您提供帮助。



在下文中一共展示了Autosummary类的6个代码示例,这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞,您的评价将有助于我们的系统推荐出更棒的Python代码示例。

示例1: run

    def run(self):
        from inspect import isclass, isfunction

        self.warnings = []
        nodelist = []

        try:
            localnames, fqns, objs = find_mod_objs(self.arguments[0])
        except ImportError:
            self.warnings = []
            self.warn("Couldn't import module " + self.arguments[0])
            return self.warnings

        try:
            # set self.content to trick the Autosummary internals.
            # Be sure to respect functions-only and classes-only.
            funconly = 'functions-only' in self.options
            clsonly = 'classes-only' in self.options

            skipmap = {}
            if 'skip' in self.options:
                skipnames = set(self.options['skip'])
                for lnm, fqnm in zip(localnames, fqns):
                    if lnm in skipnames:
                        skipnames.remove(lnm)
                        skipmap[fqnm] = lnm
                if len(skipnames) > 0:
                    self.warn('Tried to skip objects {objs} in module {mod}, '
                              'but they were not present.  Ignoring.'.format(
                              objs=skipnames, mod=self.arguments[0]))

            if funconly and not clsonly:
                cont = []
                for nm, obj in zip(fqns, objs):
                    if nm not in skipmap and isfunction(obj):
                        cont.append('~' + nm)
            elif clsonly:
                cont = []
                for nm, obj in zip(fqns, objs):
                    if nm not in skipmap and isclass(obj):
                        cont.append('~' + nm)
            else:
                if clsonly and funconly:
                    self.warning('functions-only and classes-only both '
                                 'defined. Skipping.')
                cont = ['~' + nm for nm in fqns if nm not in skipmap]

            self.content = cont

            #can't use super because Sphinx/docutils has trouble
            #return super(Autosummary,self).run()
            nodelist.extend(Autosummary.run(self))
            return self.warnings + nodelist
        finally:  # has_content = False for the Automodsumm
            self.content = []
开发者ID:ehsteve,项目名称:astropy,代码行数:55,代码来源:automodsumm.py


示例2: run

    def run(self):
        from inspect import isclass, isfunction

        nodelist = []

        try:
            localnames, fqns, objs = find_mod_objs(self.arguments[0])
        except ImportError:
            self.warnings = []
            self.warn("Couldn't import module " + self.arguments[0])
            return self.warnings

        try:
            # set self.content to trick the Autosummary internals.
            # Be sure to respect functions-only and classes-only.
            funconly = 'functions-only' in self.options
            clsonly = 'classes-only' in self.options
            if funconly and not clsonly:
                cont = []
                for nm, obj in zip(fqns, objs):
                    if isfunction(obj):
                        cont.append('~' + nm)
            elif clsonly:
                cont = []
                for nm, obj in zip(fqns, objs):
                    if isclass(obj):
                        cont.append('~' + nm)
            else:
                if clsonly and funconly:
                    self.warning('functions-only and classes-only both '
                                 'defined. Skipping.')
                cont = ['~' + objname for objname in fqns]
            self.content = cont

            #can't use super because Sphinx/docutils has trouble
            #return super(Autosummary,self).run()
            nodelist.extend(Autosummary.run(self))
            return nodelist
        finally:  # has_content = False for the Automodsumm
            self.content = []
开发者ID:phn,项目名称:astropy,代码行数:40,代码来源:automodsumm.py


示例3: get_items

 def get_items(self, names):
     items = Autosummary.get_items(self, names)
     items = [self._replace_pandas_items(*item) for item in items]
     return items
开发者ID:LLx2,项目名称:pandas,代码行数:4,代码来源:conf.py


示例4: get_items

 def get_items(self, names):
     self.genopt['imported-members'] = True
     return Autosummary.get_items(self, names)
开发者ID:bnaul,项目名称:gatspy,代码行数:3,代码来源:automodsumm.py


示例5: run

    def run(self):
        env = self.state.document.settings.env
        modname = self.arguments[0]

        self.warnings = []
        nodelist = []

        try:
            localnames, fqns, objs = find_mod_objs(modname)
        except ImportError:
            self.warnings = []
            self.warn("Couldn't import module " + modname)
            return self.warnings

        try:
            # set self.content to trick the Autosummary internals.
            # Be sure to respect functions-only and classes-only.
            funconly = 'functions-only' in self.options
            clsonly = 'classes-only' in self.options

            skipnames = []
            if 'skip' in self.options:
                option_skipnames = set(self.options['skip'])
                for lnm in localnames:
                    if lnm in option_skipnames:
                        option_skipnames.remove(lnm)
                        skipnames.append(lnm)
                if len(option_skipnames) > 0:
                    self.warn('Tried to skip objects {objs} in module {mod}, '
                              'but they were not present.  Ignoring.'.format(
                              objs=option_skipnames, mod=modname))

            if funconly and not clsonly:
                cont = []
                for nm, obj in zip(localnames, objs):
                    if nm not in skipnames and inspect.isroutine(obj):
                        cont.append(nm)
            elif clsonly:
                cont = []
                for nm, obj in zip(localnames, objs):
                    if nm not in skipnames and inspect.isclass(obj):
                        cont.append(nm)
            else:
                if clsonly and funconly:
                    self.warning('functions-only and classes-only both '
                                 'defined. Skipping.')
                cont = [nm for nm in localnames if nm not in skipnames]

            self.content = cont

            # for some reason, even though ``currentmodule`` is substituted in,
            # sphinx doesn't necessarily recognize this fact.  So we just force
            # it internally, and that seems to fix things
            env.temp_data['py:module'] = modname

            # can't use super because Sphinx/docutils has trouble return
            # super(Autosummary,self).run()
            nodelist.extend(Autosummary.run(self))

            return self.warnings + nodelist
        finally:  # has_content = False for the Automodsumm
            self.content = []
开发者ID:bnaul,项目名称:gatspy,代码行数:62,代码来源:automodsumm.py


示例6: get_items

 def get_items(self, names):
     items = Autosummary.get_items(self, names)
     items = [self._replace_pandas_items(*item) for item in items]
     items = list(self._add_deprecation_prefixes(items))
     return items
开发者ID:sinhrks,项目名称:pandas,代码行数:5,代码来源:conf.py



注:本文中的sphinx.ext.autosummary.Autosummary类示例由纯净天空整理自Github/MSDocs等源码及文档管理平台,相关代码片段筛选自各路编程大神贡献的开源项目,源码版权归原作者所有,传播和使用请参考对应项目的License;未经允许,请勿转载。


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

专题导读
上一篇:
Python intersphinx.read_inventory_v2函数代码示例发布时间:2022-05-27
下一篇:
Python autosummary.import_by_name函数代码示例发布时间:2022-05-27
热门推荐
阅读排行榜

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap