首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

从Sphinx autodoc扩展的文档中排除静态成员

Sphinx autodoc是Sphinx文档生成工具的一个扩展,用于自动提取和生成文档。在使用Sphinx autodoc生成文档时,有时我们希望排除一些静态成员,以避免生成冗余或不必要的文档内容。

静态成员是指在类或模块中定义的但不属于实例的成员,例如类的静态方法、类变量和模块级函数等。如果我们希望在生成文档时排除这些静态成员,可以通过在Sphinx配置文件中进行相应的设置来实现。

首先,在Sphinx的配置文件(通常是conf.py)中添加以下代码:

代码语言:txt
复制
def skip_static_member(app, what, name, obj, skip, options):
    if skip and what == 'class' and name.startswith('_'):
        return False
    return skip

def setup(app):
    app.connect('autodoc-skip-member', skip_static_member)

上述代码定义了一个名为skip_static_member的函数,用于判断是否跳过静态成员。在函数中,我们通过判断成员的名称是否以下划线开头来决定是否跳过该成员。如果需要排除其他条件的静态成员,可以根据实际情况进行修改。

接下来,在配置文件的末尾添加以下代码,将上述函数注册为Sphinx的扩展:

代码语言:txt
复制
extensions = [
    # 其他扩展
    'sphinx.ext.autodoc',
    # 其他扩展
]

# 注册自定义的扩展
setup(app)

完成以上步骤后,重新生成文档即可排除静态成员。生成的文档将不包含以下划线开头的静态成员。

需要注意的是,以上方法是基于Sphinx autodoc扩展的文档生成工具实现的,适用于Sphinx文档生成工具的项目。对于其他文档生成工具或框架,可能需要采用不同的方法来排除静态成员。

关于Sphinx autodoc的更多信息和用法,请参考腾讯云的产品文档:Sphinx autodoc扩展

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

如何使用Sphinx记录Python代码【Programming(Python)】

文档是开发过程最佳组成部分。 Sphinx与Tox一起,使得它易于编写,易于欣赏。 image.png Python代码可以在其源代码包含文档。...我们有一个文件文本。应该有人来看看。 使Python文档更漂亮 为了使您文档看起来更漂亮,您可以利用Sphinx ,它旨在制作漂亮Python文档。...这三个Sphinx扩展特别有用: sphinx.ext.autodoc模块内部获取文档 sphinx.ext.napoleon :支持Google样式文档字符串 sphinx.ext.viewcode...:将ReStructured Text源与生成文档打包在一起 为了告诉Sphinx什么以及如何生成,我们在docs / conf.py配置一个辅助文件: extensions = [ 'sphinx.ext.autodoc...我们可以docstrings开始,添加.rst文件,然后添加Sphinx和Tox为用户美化结果。 对于好文档,您欣赏什么? 你还有其他喜欢策略吗? 请在评论中分享它们!

1.1K00

使用 Sphinx 给 Python 项目生成【Read the Docs】在线文档

Sphinx 和 Read the Docs 1.1 Sphinx Sphinx 是一个强大文档生成器,具有许多用于编写技术文档强大功能,包括: 维护一份源文档,生成网页,可打印PDF,用于电子阅读器...(ePub)文档等 支持 reStructuredText 或 Markdown 编写文档 被广泛使用代码文档系统 代码示例语法高亮 活跃官方和第三方扩展生态 1.2 Read the Docs...它使用 Sphinx 生成 html 静态页面,通过 github 账户授权,在本地项目 push 到 github 仓库时,自动完成文档生成和在线更新。...1.3 两者关系 可以简单认为 Sphinx 是一个独立文档生成工具,可以支持不同主题;而 Read the Docs 是一个免费在线文档托管平台,它使用 Sphinx 作为文档生成工具,并提供自己主题...html_theme = 'sphinx_rtd_theme' 补充:如需支持 markdown ,添加 recommonmark 扩展到 extensions 配置列表: extensions =

3.2K20

关于深度学习框架Hamaa与Python API文档生成工具Sophon

:用Markdown写文档 distutils:编译Python扩展 setuptools:分发包 nose:测试 pip:包管理 virtualenv:虚拟环境 coverage:代码覆盖率统计 Python...另外,Hamaa其实已经完成了有一个月了,之所以拖了那么久才介绍是因为: 本来是打算用Sphinx+reStructuredText写API文档,但是如果用Sphinx+reST写API文档,就意味着和...因为Hamaa文档目前托管在ReadTheDocs上,而RTD只能要么使用Sphinx要么用MkDocs作为文档引擎。...考虑到文档编写、网站外貌(Sphinx很强大,但是他autodoc功能导出API文档在RTD主题下实在有点丑),最终选择了MkDocs+Markdown来编写文档。...但是这样又有了另外一个问题,MkDocs没有autodoc功能。如果手动编写,就意味着我要同时保持代码注释与API文档介绍一致。

70731

Sphinx快速制作文档

新版Python文档就是由Sphinx生成, 并且它已成为Python项目首选文档工具,同时它对 C/C++ 项目也有很好支持; 并计划对其它开发语言添加特殊支持....下面列出了其良好特性,这些特性在Python官方文档均有体现: 丰富输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages(...可自动生成美观模块索引 精确语法高亮: 基于 Pygments 自动生成语法高亮 开放扩展: 支持代码块自动测试,并包含Python模块自述文档(API docs)等 Sphinx 使用...我们需要在终端输入下列命令进行安装: pip install sphinx 创建Sphinx项目 创建一个用于存放文档文件夹,然后在该文件夹路径下运行下列命令快速生成Sphinx项目: sphinx-quickstart...参考文章 Sphinx 使用手册 使用 sphinx 制作简洁而又美观文档 使用Sphinx制作说明文档

1.8K60

使用python编写量子线路打印简单项目,并使用Sphinx自动化生成API文档

技术背景 该文章一方面量子线路打印着手,介绍了一个简单python量子线路工程。同时基于这个简单小工程,我们顺带介绍了pythonAPI文档自动化生成工具Sphinx基本使用方法。...指令将sourcerst文档编译成html文档,并输出到build目录下: [dechin@dechin-manjaro circuit]$ sphinx-build source/ build/...我们先点击这里index和module看看内容,分别为下列两个图所示: ? ? 最后在这个索引列表我们点击进入qcprinter这个类,去查看详细文档说明: ?...相应函数注释内容也会在接口文档中体现: ? 需要注意是,如果相关类或者函数是受保护类型,那么在sphinx生成文档是不会显示(构造过程自动忽略)。...总结概要 在这篇文章,我们主要通过一个量子线路打印python项目介绍,也顺带通过sphinx将python项目的注释文档自动化生成API接口文档,完成了一个项目开发及文档输出流程简要分析,在实战掌握更多工具使用方法

2.9K20

用正确姿势开源Python项目

文档 文档的话,并没有严格要求必须使用什么样工具进行构建,也没有很严格格式要求。...: 英文Sphinx 官方文档 中文Python 开发实战 官方文档非常详细,那本书偏向于实战,是很不错书。...还有很关键一点是Sphinxautodoc和automodule扩展, 可以代码中提取出文档,与代码直接进行关联。提供一个例子可以方便文档和源码中进行跳转。...现在有很多开源项目的文档都是托管在这里,具体配置可以参考官方文档。...Github和Bitbucket仓库导入,同时也可以很好和Travisci集成,在上面我们.travis.yml文件,在最后一项after_success,我们就配置了对Coveralls支持

88630

API 参考与帮助内容:一站式开发与使用者支援

API 文档可帮助开发人员了解 API 端点具体细节,并了解如何将 API 成功集成到他们软件文档生成工具 API 文档生成工具是直接源代码创建 API 文档软件应用程序。...这简化了开发人员工作流程,并确保文档与代码更改保持同步。这些工具例子包括 Doxygen、Sphinx、Javadoc、Swagger UI 和 Slate。...Slate 生成静态 HTML 外观精美,响应迅速,可以轻松托管在 Github 等网站上。 API 定义 API 代表应用程序编程接口。本质上讲,它是一套用于构建和集成应用程序软件规则和协议。...API 可用于基于 Web 服务、操作系统、数据库或软件库。它们旨在提供一致体验、简化编程并支持模块化和可扩展性。API 通常以库形式出现,其中包含用于通信程序、数据结构、对象类和协议规范。...在支持手册,您通常会找到产品或服务概述、各种程序分步说明、用于解决常见问题故障排除部分以及更深入支持联系人列表。

9210

Python开发工具大揭秘:提高生产力秘密武器

在Python开发世界,正确工具可以让你事半功倍。本文将向你介绍一些受欢迎Python开发工具,以及如何使用它们来提高你编程效率和代码质量。 1....版本控制 Git Git是一个强大版本控制系统,用于跟踪代码变更和协作开发。你可以使用Git来管理你项目,并与团队成员合作。...文档生成 Sphinx Sphinx是一个用于生成文档工具,特别适用于Python项目。它可以代码注释中生成美观文档。...# 代码示例:使用Sphinx生成文档 sphinx-quickstart # 初始化Sphinx项目 sphinx-apidoc -o docs/source mymodule # 生成API文档...无论你是初学者还是有经验开发者,这些工具都是提高生产力秘密武器,让你在Python编程旅程取得成功!

21030

博客生成静态站点工具 Top 20

正如它声称那样,在你用来搭建静态网站所有工具,Nuxt 可以做到功能和灵活性两全其美。他们还提供了一个 Nuxt 线上沙盒,让你不费吹灰之力就能直接测试它。...功能强大:Sphinx支持自动生成文档索引、导航、搜索等功能,并提供了代码高亮、图表绘制等扩展功能。 可扩展性:Sphinx可以轻松地与其他工具和语言集成,如Python、C++等。...多种输出格式:Sphinx支持生成HTML、PDF、EPUB等多种格式文档,方便发布和分享文档。 社区支持:Sphinx 是一个开源项目,有庞大社区支持和开发者社区,您可以轻松地获取帮助和支持。...Sphinx 适用于各种类型技术文档编写,包括软件文档、API 文档、学术论文等。 你可以查看它 GitHub和官网了解更多。 21.小结 博客静态站点生成工具多如牛毛,不胜枚举。...这些工具大多数都支持 Markdown 等轻量级格式,并提供了许多主题和插件,可以方便地创建漂亮博客。此外,这些工具也有很好文档和社区支持,使得学习和使用它们变得更加容易。

3.3K21

快速、简单、美观:构建现代化文档工具链

这些开源项目旨在为用户提供一种简单而强大方式来构建现代化文档静态网站。它们拥有一些关键特性:简洁易用、支持使用Markdown编写内容、提供多种主题选择和插件扩展能力。...是一个快速、简单且极具美感静态网站生成器,旨在构建项目文档。...以下是该项目的关键特性和核心优势: Markdown 文件构建静态 HTML 文件。 使用插件和 Markdown 扩展增强 MkDocs 功能。...强大扩展性:基于 Vue 组件系统进行开发,充分利用了 Vue 生态圈丰富而成熟插件库。您可以轻松添加自定义主题、布局或其他功能来满足不同场景下需求。...它支持使用 reStructuredText 编写 Sphinx 文档,并可以 Subversion、Bazaar、Git 和 Mercurial 仓库拉取代码,然后为您构建和托管文档

34830

使用 Python 30分钟 教你快速搭建一个博客

实现大体思路如下: Markdown:书写文档 Pandoc:格式转化 Sphinx:生成网页 GitHub:托管项目 ReadtheDocs:发布网页 接下来,就来看看到底是如何实现?...03 配置及扩展 ---- Sphinx 配置文件是 source\conifg.py 由于修改内容比较多而杂,为了使这个搭建过程,更加顺畅。 小明已经给你精心准备了一份配置文件。...你只要关注我公众号,后台直接回复 「Sphinx」即可获取。 关于配置文件,我做了哪些事: 配置主题 支持LaTeX 支持中文检索 以上配置文件,需要搭配扩展模块才能使用。...扩展模块同样我也给你准备好了,在你回复「Sphinx」后,获取压缩包后,里面有个 exts 文件夹。你只要将这个文件夹原封不动放置在与source同级目录下即可。...这里要提醒一下是,Sphinx文档格式,默认是 rst 格式,如果你习惯了使用Markdown来写文章,可以使用 Pandoc 这个神器转换一下。 这里给出转换命令。

1K20

Sphinx初尝

可自动生成美观模块索引 精确语法高亮: 基于 Pygments 自动生成语法高亮 开放扩展: 支持代码块自动测试,并包含Python模块自述文档(API docs)等 Sphinx 使用 reStructuredText...请输入以下设置值(只需按Enter 接受默认值(如果在括号给出)。 选定根路径:。 您有两个选择来放置Sphinx输出构建目录。...您可以在根路径中使用目录“ _build”,也可以单独使用 根路径“源”和“构建”目录。 有一些提示,自己摁 项目名称将在生成文档多个位置出现。...完成 写其他页面...搜索完成 复制静态文件...完成 复制多余文件...完成 用英语(代码:en)倾销搜索索引...完成 倾销对象清单...完成 建立成功。...HTML页面位于build \ html。 编译过后目录是这样 里面有三个html文件,都打开看看 以上是打开三个网页文档 那我写完就想自动预览文档,咋办?

1.6K20

使用restructedtext编写xresloader文档

这次拖这么长时间主要是因为最近学习了一个新文本标记语言 – ReStructuredText 。并且重新整理了Excel导表工具-xresloader工具集文档,写文档真是好废好废时间啊。...好多项目用ReStructuredText来写文档来着,比如cmake,再比如python。然后现在有比较容易上手readthedocs来托管文档,和github集成也还不错。...但是使用 Markdown 写文档还是略麻烦,特别是涉及跨文档引用和多行表格时候,而且 Markdown 各个平台组件和扩展还都不一样,没有统一标准。...ReStructuredText官方生成工具是sphinxsphinx还能自己指定主题,分析目录,生成静态搜索索引。这个 静态搜索索引 真的是非常实用,这样生成文档也有搜索功能了。...拿xresloader当小白鼠原因是对之前文档不满意,对新手上手来说还很不明晰。而且xresloader流程比较多,也比较适合多文档结构。

47210

Sphinx+gitee+Read the Docs搭建在线文档系统

本文介绍一种在线文档系统搭建,需要借助Sphinx、gitee和Read the Docs。...Sphinx是一个功能强大文档生成器,具有许多用于编写技术文档强大功能 gitee是一种版本管理系统,相比github,有着更快访问速度 Read the Docs是一个在线文档托管服务, 你可以各种版本控制系统中导入文档...1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinx,在windows命令行输入下面的命令 pip install -i...这里先简单说明一下各个文件作用: build:生成文件输出目录 source: 存放文档源文件 _static:静态文件目录,比如图片等 _templates:模板目录 conf.py:进行 Sphinx...然后编辑soure/Cpp文件夹里index.rst文件,这里表示该目录级别下,又包含了3个子目录,子目录再次通过index文件来描述子目录文档结构: C++知识 ===============

1.8K30

Elasticsearch API汇总

此命令常见用途一般有两个: 验证节点之间健康状况是否一致; 跟踪大型集群随时间故障恢复情况; 官方文档-cat health API GET /_cat/health?...迁移结束之后,取消节点禁用策略 集群中排除节点: PUT _cluster/settings { "transient": { "cluster.routing.allocation.exclude...这是因为每个文档存储到哪一个 shard 是和 number_of_shards 这个数值有关。一旦这个数值发生改变,那么之后寻找那个文档所在 shard 就会不准确。...setting设置 http://localhost:9200/_all/_settings 集群索引信息 描述:查询集群全部索引索引、主副本、状态、文档数、节点等信息。...shards命令详细描述了节点包含分片信息。它将告诉您它是一个主分片还是一个副本,和文档数量,硬盘上占用字节数,以及节点所在位置。

1.1K20

Sphinx补篇

也就是说,如果您目录包含一堆reST格式文档(可能还有文档子目录)以及),Sphinx可以生成结构良好HTML文件(在其他目录),以方便浏览和导航。...但是同一来源,它还可以生成LaTeX文件,也可以将其编译为文档PDF版本,或者直接使用rst2pdf编译为PDF文件。 ?...就像这样 ---- 在命令选项板(Ctrl-Shift-P或Cmd-Shift-P)输入命令,并在表语法中使用光标位置。当前表格将被格式化。或者,您可以将所有表语法格式化为打开文本。...和文档一样 ? 有自动补全就舒服 ? 一个reStructuredText标记元素,它可以标记具有特殊含义内容块。指令不仅由docutils提供,而且Sphinx和自定义扩展可以添加自己指令。...#build-config 基本配置 之前提及我们使用 conf.py 脚本来控制 Sphinx 怎么处理文档.

1.1K10

Python利用sphinx构建个人博客

一、基础概念 利用sphinx+pandoc+github+readthedocs构建个人博客 Sphinx: 是一个基于ReStructuredText文档生成工具,可以令人轻松撰写出清晰且优美的文档...新版Python文档就是由Sphinx生成,并且它已成为Python项目首选文档工具,同时它对C/C++项目也有很好支持;并计划对其它开发语言添加特殊支持。...Read the Docs是一个在线文档托管服务,可以各种版本控制系统中导入文档。支持webhooks,当你提交代码时,文档将被自动构建。...二、流程 Sphinx + GitHub + ReadtheDocs 作为一个文档写作工具,利用pandoc文本转换, 用Sphinx生成文档,GitHub托管文档,再导入到 ReadtheDocs。...,生成html静态文件都存放在这里 ├── make.bat ├── Makefile #编译文件用 make 命令时,可以使用这些指令来构建文档输出 └── source

2.2K21

5步搭建一个测试文档管理网站

安装Sphinx Sphinx是一个基于Python文档生成项目,最早只是用来生成 Python 官方文档,随着工具完善,越来越多知名项目也用他来生成文档。...Sphinx原理很简答,就是把特定格式书写文档,通过约定转换方式,生成对应HTML文档。这里书写文档可以支持多种格式,生成HTML也可以支持多种模板。...创建一个文档项目 安装好Sphinx之后,我们就可以通过它来创建实际文档项目,主要命令如下: mkdir -p /data/testdocs cd /data/testdocs sphinx-quickstart...当然,如果你希望其他人也能访问到这个网页,最好办法就是搭建一个nginx服务,来代理这些静态html文件即可! 4....当然,官方支持reStructuredText语言,能够支持格式会更多。比如:markdown表格就不被支持。

76020
领券