草庐IT

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 - 将 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

python - 如何在不安装的情况下直接运行 Python Egg 文件?

是否可以像用Java运行jar文件一样直接运行Python的egg文件?例如,对于Java,您可能会执行以下操作:$java-jarjar-file 最佳答案 一个pythonegg是一种“单文件可导入分发格式”。这通常是一个python包。只要你知道它的名字并且在你的路径中,你就可以将包导入到egg中。您可以使用“-m”选项和包名来执行包。但是,python包在执行时通常不会做任何事情,并且您可能会收到错误消息。-c选项可用于运行代码。(有关命令行选项的详细信息,请参阅http://docs.python.org/using/cm

python - 如何在不安装的情况下直接运行 Python Egg 文件?

是否可以像用Java运行jar文件一样直接运行Python的egg文件?例如,对于Java,您可能会执行以下操作:$java-jarjar-file 最佳答案 一个pythonegg是一种“单文件可导入分发格式”。这通常是一个python包。只要你知道它的名字并且在你的路径中,你就可以将包导入到egg中。您可以使用“-m”选项和包名来执行包。但是,python包在执行时通常不会做任何事情,并且您可能会收到错误消息。-c选项可用于运行代码。(有关命令行选项的详细信息,请参阅http://docs.python.org/using/cm

python - 如何在 Sphinx 中扩展侧边栏目录树上的所有小节?

我想知道是否有一种方法可以扩展index.rst文件中包含的标题下的所有小节?例如,它是这样的:Section1Section2Section3这就是我想要的样子:Section1Subsection1.1Subsection1.2Subsection1.3Section2Subsection2.1Subsection2.2Subsection2.3Section3Subsection3.1Subsection3.2Subsection3.3如果我点击第1部分,它会显示下面的内容,但如果我点击第2部分,第1部分的内容将被隐藏,仅显示2部分。我希望每次在索引页面上都扩展所有2个部分。我试

python - 如何在 Sphinx 中扩展侧边栏目录树上的所有小节?

我想知道是否有一种方法可以扩展index.rst文件中包含的标题下的所有小节?例如,它是这样的:Section1Section2Section3这就是我想要的样子:Section1Subsection1.1Subsection1.2Subsection1.3Section2Subsection2.1Subsection2.2Subsection2.3Section3Subsection3.1Subsection3.2Subsection3.3如果我点击第1部分,它会显示下面的内容,但如果我点击第2部分,第1部分的内容将被隐藏,仅显示2部分。我希望每次在索引页面上都扩展所有2个部分。我试