草庐IT

sphinx-argparse

全部标签

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 argparse传入布尔参数不生效的解决方法

在一个需要用到flag作为信号控制代码中一些代码片段是否运行的,比如"--flagTrue"或者"--flagFalse"。但是古怪的是无法传入False,无论传入True还是False,程序里面都是True的参数,所以这个flag并没有生效,也就失去了意义。参考代码:importargparsedeftest_bool():parser=argparse.ArgumentParser(description="Thiscodeisusedtotestboolvalue.")parser.add_argument("--flag",type=bool,default=True)args=par

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

【小沐学Python】Python实现在线电子书(Sphinx + readthedocs + github + Markdown)

文章目录1、简介2、安装3、创建测试工程4、项目文件结构5、编译为本地文件6、编译为http服务7、更改样式主题8、支持markdown9、修改文档显示结构10、项目托管到github11、部署到ReadtheDocs结语1、简介Sphinx是一个文档生成器,您也可以把它看成一种工具,它可以将一组纯文本源文件转换成各种输出格式,并且自动生成交叉引用、索引等。也就是说,如果您的目录包含一堆reStructuredText或Markdown文档,那么Sphinx就能生成一系列HTML文件,PDF文件(通过LaTeX),手册页等。Sphinx专注于文档,尤其是handwrittendocumenta

python - cli 中的 argparse Python 模块

我正在尝试从LinuxSSHSecureShell命令行环境运行python脚本,并且我正在尝试导入argparse库,但它给出了错误:“ImportError:没有名为argparse的模块”。我认为这是因为Linuxshell使用的Python环境中没有argparse库,如果我能找到Python使用的库的目录,我想我可以修复它环境,并将argparse库复制到其中,但我找不到该目录所在的位置。如果能帮助我找到这个目录,我将不胜感激(我想我现在可以将argparse库包含在与我的python脚本相同的目录中,但我更愿意将argparse库放在其他Python库所在的位置,因为它应该