草庐IT

sphinx-apidoc-Implicit-namespaces

全部标签

python - 如何将 Sphinx 的 Autodoc 扩展用于私有(private)方法?

我正在使用Sphinx来记录我的python项目。我启用了autodoc扩展,并且在我的文档中有以下内容。..autoclass::ClassName:members:问题是,它只记录了类中的非私有(private)方法。我如何也包含私有(private)方法? 最佳答案 如果您使用的是sphinx1.1或更高版本,请访问sphinx文档站点http://www.sphinx-doc.org/en/master/ext/autodoc.html,:special-members::private-members:

python: xml.etree.ElementTree,删除 "namespaces"

我喜欢ElementTree解析xml的方式,尤其是Xpath功能。我有一个带有嵌套标签的应用程序的xml输出。我想在不指定命名空间的情况下按名称访问这些标签,可以吗?例如:root.findall("/molpro/job")代替:root.findall("{http://www.molpro.net/schema/molpro2006}molpro/{http://www.molpro.net/schema/molpro2006}job") 最佳答案 至少使用lxml2,可以在一定程度上减少这种开销:root.findall(

python: xml.etree.ElementTree,删除 "namespaces"

我喜欢ElementTree解析xml的方式,尤其是Xpath功能。我有一个带有嵌套标签的应用程序的xml输出。我想在不指定命名空间的情况下按名称访问这些标签,可以吗?例如:root.findall("/molpro/job")代替:root.findall("{http://www.molpro.net/schema/molpro2006}molpro/{http://www.molpro.net/schema/molpro2006}job") 最佳答案 至少使用lxml2,可以在一定程度上减少这种开销:root.findall(

Python 3.5+ : How to dynamically import a module given the full file path (in the presence of implicit sibling imports)?

问题标准库明确记录howtoimportsourcefilesdirectly(给定源文件的绝对文件路径),但如果源文件使用下面示例中描述的隐式同级导入,则此方法不起作用。如果存在隐式同级导入,该示例如何适应工作?我已经checkoutthis和thisotherStackoverflow有关该主题的问题,但它们没有解决手动导入的文件内的隐式同级导入。设置/示例这是一个说明性示例目录结构:root/-directory/-app.py-folder/-implicit_sibling_import.py-lib.pyapp.py:importosimportimportlib.util

Python 3.5+ : How to dynamically import a module given the full file path (in the presence of implicit sibling imports)?

问题标准库明确记录howtoimportsourcefilesdirectly(给定源文件的绝对文件路径),但如果源文件使用下面示例中描述的隐式同级导入,则此方法不起作用。如果存在隐式同级导入,该示例如何适应工作?我已经checkoutthis和thisotherStackoverflow有关该主题的问题,但它们没有解决手动导入的文件内的隐式同级导入。设置/示例这是一个说明性示例目录结构:root/-directory/-app.py-folder/-implicit_sibling_import.py-lib.pyapp.py:importosimportimportlib.util

python - 将 Sphinx autodoc-skip-member 连接到我的函数

我想使用sphinx'sautodoc-skip-member事件来选择某个python类上的一部分成员进行文档。但从sphinx文档中并不清楚,我找不到任何示例说明:我在哪里放置代码来连接它?我看到了Sphinx.connect我怀疑它在我的conf.py中,但是当我在conf.py中尝试对这段代码进行变体时,我找不到应该连接()的应用程序对象:defmaybe_skip_member(app,what,name,obj,skip,options):printapp,what,name,obj,skip,optionsreturnFalse#Thisisnotevenclosetoc

python - 将 Sphinx autodoc-skip-member 连接到我的函数

我想使用sphinx'sautodoc-skip-member事件来选择某个python类上的一部分成员进行文档。但从sphinx文档中并不清楚,我找不到任何示例说明:我在哪里放置代码来连接它?我看到了Sphinx.connect我怀疑它在我的conf.py中,但是当我在conf.py中尝试对这段代码进行变体时,我找不到应该连接()的应用程序对象:defmaybe_skip_member(app,what,name,obj,skip,options):printapp,what,name,obj,skip,optionsreturnFalse#Thisisnotevenclosetoc

Sphinx入门教程

1.新建sphinx文件夹输入命令行以下命令行安装sphinxpipinstallsphinx再输入命令,使用向导创建文档项目sphinx-quickstart 创建完成后,sphinx_demo文件夹新增了以下文件 2.运行初始化项目文档命令窗口输入命令,生成html文件.\makehtml 可打开html文件查看文档页面  3.修改项目配置(1)修改项目主题A.控制台输入命令,安装主题pipinstallfuro B.修改配置项 C.命令行输入‘.\makeclean’,再输入命令行‘.\makehtml’,打开页面 (2)兼容markdown文件A.在source文件夹下,新增.md文件

python - 如何将自定义 css 文件添加到 Sphinx?

如何添加自定义css文件?以下配置不起作用:#conf.pyhtml_static_path=['_static']html_theme='default'html_theme_options={'cssfiles':['_static/style.css']}结果:$makehtmlRunningSphinxv1.2.2loadingpickledenvironment...notyetcreatedbuilding[html]:targetsfor2sourcefilesthatareoutofdateupdatingenvironment:2added,0changed,0rem

python - 如何将自定义 css 文件添加到 Sphinx?

如何添加自定义css文件?以下配置不起作用:#conf.pyhtml_static_path=['_static']html_theme='default'html_theme_options={'cssfiles':['_static/style.css']}结果:$makehtmlRunningSphinxv1.2.2loadingpickledenvironment...notyetcreatedbuilding[html]:targetsfor2sourcefilesthatareoutofdateupdatingenvironment:2added,0changed,0rem