草庐IT

Sphinx-apidoc

全部标签

python - 如何使用零配置的 Sphinx 生成 Python 文档?

我们不想维护文档和源代码,它们目前正在迅速发展,但Sphinx似乎需要大量的设置和配置。(我们只需要一些基本的API文档。)是否没有一个命令可以在python项目中运行,它只会迭代所有包、模块、类和函数,生成HTML文档?sphinx-apidoc把东西放到一个目录中,在修改conf.py使我们的包在sys.path中之后,我们可以运行“makehtml”,但它只列出包和模块,而没有记录任何类或函数.谢谢! 最佳答案 sphinx-apidoc工具将为您的模块自动生成stub,这可能是您想要的。说明确保在Sphinx配置期间启用了a

python - 如何使用零配置的 Sphinx 生成 Python 文档?

我们不想维护文档和源代码,它们目前正在迅速发展,但Sphinx似乎需要大量的设置和配置。(我们只需要一些基本的API文档。)是否没有一个命令可以在python项目中运行,它只会迭代所有包、模块、类和函数,生成HTML文档?sphinx-apidoc把东西放到一个目录中,在修改conf.py使我们的包在sys.path中之后,我们可以运行“makehtml”,但它只列出包和模块,而没有记录任何类或函数.谢谢! 最佳答案 sphinx-apidoc工具将为您的模块自动生成stub,这可能是您想要的。说明确保在Sphinx配置期间启用了a

python - Sphinx 在使用 autodoc 时找不到 Python 包

在为实际项目创建文档之前,我正在尝试为测试Python项目创建文档。我的系统:Win764位,python2.7.564位。我的项目名称是testDoc。它包括名为t的pythonpakage,其中包括2个模块t1和t2以及__init__.py。__init__.py包含:importt1importt2t1.py包含:'''Createdon272013@author:'''classMyClass(object):'''Hi'''def__init__(self,selfparams):'''Constructor'''pass要创建文档,我在testDoc的命令行中运行:sph

python - Sphinx 在使用 autodoc 时找不到 Python 包

在为实际项目创建文档之前,我正在尝试为测试Python项目创建文档。我的系统:Win764位,python2.7.564位。我的项目名称是testDoc。它包括名为t的pythonpakage,其中包括2个模块t1和t2以及__init__.py。__init__.py包含:importt1importt2t1.py包含:'''Createdon272013@author:'''classMyClass(object):'''Hi'''def__init__(self,selfparams):'''Constructor'''pass要创建文档,我在testDoc的命令行中运行:sph

html - 在 Sphinx 文档中添加垂直空间

我正在使用sphinx构建包含大量图形和枚举列表的latex和HTML文档。当我在枚举列表之外的文本中间使用数字时,latex和HTML中带和不带标题的间距都很好。上下大概有一线空间,可以接受。但是,当我尝试在枚举列表中使用图形时,例如下面的示例,HTML中的间距不正确。#.Hereisaniteminthelist,abovethefigure..figure::_images/myimage.png:align:center:width:80%#.Hereisanotheritembelowthefigure.上述代码的结果是图形的底部紧靠列表中的下一项。它们之间没有间距,这看起来

html - 在 Sphinx 文档中添加垂直空间

我正在使用sphinx构建包含大量图形和枚举列表的latex和HTML文档。当我在枚举列表之外的文本中间使用数字时,latex和HTML中带和不带标题的间距都很好。上下大概有一线空间,可以接受。但是,当我尝试在枚举列表中使用图形时,例如下面的示例,HTML中的间距不正确。#.Hereisaniteminthelist,abovethefigure..figure::_images/myimage.png:align:center:width:80%#.Hereisanotheritembelowthefigure.上述代码的结果是图形的底部紧靠列表中的下一项。它们之间没有间距,这看起来

html - Python Sphinx 中的 RTL 支持

有没有办法在Sphinx中使用RTL(从右到左,如波斯语、阿拉伯语……)文本?从.rst文件生成HTML时,生成的HTML是LTR(默认情况下从左到右)并左对齐,我的问题是如何更改它,使其成为RTL,并右对齐。 最佳答案 可以查看python的docutilsFAQ.它解释了如何使用css和类来标记文本方向。 关于html-PythonSphinx中的RTL支持,我们在StackOverflow上找到一个类似的问题: https://stackoverflow

html - Python Sphinx 中的 RTL 支持

有没有办法在Sphinx中使用RTL(从右到左,如波斯语、阿拉伯语……)文本?从.rst文件生成HTML时,生成的HTML是LTR(默认情况下从左到右)并左对齐,我的问题是如何更改它,使其成为RTL,并右对齐。 最佳答案 可以查看python的docutilsFAQ.它解释了如何使用css和类来标记文本方向。 关于html-PythonSphinx中的RTL支持,我们在StackOverflow上找到一个类似的问题: https://stackoverflow

python - Python 模块/包名称的 Sphinx apidoc 部分标题

当我运行sphinx-apidoc然后makehtml时,它会生成包含“Subpackages”和“Submodules”部分以及“module”和“package”的文档页面目录(TOC)中每个模块/包名称的末尾。如何在不编辑Sphinx源代码的情况下防止编写这些额外的标题?这是我想制作的示例文档页面(注意目录):http://selenium.googlecode.com/svn/trunk/docs/api/py/index.html#documentation我理解这是由于sphinx源中的apidoc.py文件(第88行):https://bitbucket.org/birk

python - Python 模块/包名称的 Sphinx apidoc 部分标题

当我运行sphinx-apidoc然后makehtml时,它会生成包含“Subpackages”和“Submodules”部分以及“module”和“package”的文档页面目录(TOC)中每个模块/包名称的末尾。如何在不编辑Sphinx源代码的情况下防止编写这些额外的标题?这是我想制作的示例文档页面(注意目录):http://selenium.googlecode.com/svn/trunk/docs/api/py/index.html#documentation我理解这是由于sphinx源中的apidoc.py文件(第88行):https://bitbucket.org/birk