草庐IT

sphinx-argparse

全部标签

python - 获取 sphinx 自动模块的 "flat"成员输出

我正在使用Sphinxautodoc扩展来记录模块,我想在文档输出中获取模块成员的平面列表。我尝试使用以下方法:..automodule::modname:members:但是,这有两个问题:它包括模块的文档字符串,我不在这里想要它。每个条目的名称都以“modname.”为前缀,这是完全多余的(因为此页面专门用于记录此模块)但是,我找不到任何配置选项可以让我有选择地禁用这两个方面,同时仍然获得所有模块成员的自动列表。我目前的计划是只使用自动函数(等)并显式枚举要记录的成员,但我仍然想知道我是否错过了实现我最初想要的东西的简单方法。更新:我至少找到了第二部分的解决方法:在conf.py中

python - 如何在不复制所有内容的情况下将 Sphinx 与子包一起使用?

我有以下包结构作为最小示例(为方便起见,全部上传here):.├──sphinx│  ├──build│  ├──Makefile│  └──source│  ├──conf.py│  ├──index.rst│  └──train.rst└──train├──__init__.py└──train.py编写Python包时,必须在任何包的__init__.py中指定__all__常量,以便Sphinx能够映射引用,例如train.DatasetMeta到train.train.DatasetMeta或类似的。但是,sphinx-apidoc为这些包生成以下部分:trainpackag

python - 为什么 virtualenv 环境包含 argparse、distribute 和 wsgiref?

这个问题在这里已经有了答案:Whydoespipfreezereportsomepackagesinafreshvirtualenvcreatedwith--no-site-packages?(2个答案)关闭9年前。我正在使用virtualenv版本1.7.1.2和python2.7.3来创建虚拟python环境。但是当我创建这样一个环境并激活它时,我可以看到安装了以下包(使用pipfreeze):argparse==1.2.1distribute==0.6.24wsgiref==0.1.2这是为什么呢?这是什么意思?

Python argparse 条件要求

如何设置argparse如下:if-2isonthecommandline,nootherargumentsarerequiredif-2isnotonthecommandline,-3and-4argumentsarerequired例如,-2[good]-3a-4b[good]-3a[notgood,-4required]-2-5c[good]-2-3a[good]这里有很多类似的问题,但要么他们没有解决这种情况,要么我不明白。Python2.7如果重要的话。 最佳答案 子解析器(如评论中所建议的)可能会起作用。另一种选择(因为

python - argparse 中的自定义 'usage' 函数?

是否可以添加自定义“用法”函数而不是pythonargparse提供的默认用法消息。示例代码:parser=argparse.ArgumentParser(description='Sampleargparsepy')parser.add_argument('-arg_1',type=int,custom_usage_funct('with_some_message'))output=parser.parse_args()defcustom_usage_funct(str):printstrprint'''Usage:program.py[-a,Passargumenta][-b,Pa

nargs > 1 的 Python argparse 类型和选择限制

标题几乎说明了一切。如果我的nargs大于1,有什么方法可以对解析的单个args设置限制(例如选择/类型)?这是一些示例代码:parser=argparse.ArgumentParser()parser.add_argument('-c','--credits',nargs=2,help='numberofcreditsrequiredforasubject')对于-c参数,我需要指定一个主题以及需要多少学分。主题应限于预定义的主题列表,并且所需的学分数量应该是float的。我可能可以使用子解析器来完成此操作,但实际上这已经是子命令的一部分,所以我真的不希望事情变得更复杂。

python - 为什么在 argparse 中, 'True' 总是 'True' ?

这个问题在这里已经有了答案:Parsingbooleanvalueswithargparse(26个答案)关闭5年前。这是最简单的Python脚本,名为test.py:importargparseparser=argparse.ArgumentParser()parser.add_argument('--bool',default=True,type=bool,help='Booltype')args=parser.parse_args()print(args.bool)但是当我在命令行上运行这段代码时:pythontest.py--boolFalseTrue而当我的代码读取'--bo

python - 将我的 Markdown 自述文件包含到 Sphinx 中

我想将我项目的README.md包含到我的Sphinx文档中,如Cansphinxlinktodocumentsthatarenotlocatedindirectoriesbelowtherootdocument?-在生成的Sphinxhtml文档中,我单击欢迎页面目录中的链接并转到README.md。为此,创建了一个文档readme_link.rst,其中包含以下行ReadmeFile-----------..include::../../README.md然后我添加行README进入index.rst目录树。随之而来的是,我的README.md没有被解析为Markdown,而是按原

python - 源文件更改时自动构建 Sphinx 文档

我正在使用Sphinx记录我的一个项目,我喜欢在浏览器中预览我的更改。我希望能够将一些更改保存到.rst文件,并能够立即刷新我的浏览器并查看更改。本质上,只要其中一个.rst文件发生更改,我就想自动执行makehtml。 最佳答案 您可以使用sphinx-autobuild.使用方便,例如:sphinx-autobuilddocsdocs/_build/html或者,如果您有单独的构建目录,sphinx-autobuildsourcebuild/html它还会在浏览器中自动启动页面刷新。

python - 如何将 python 的 argparse 与预定义的参数字符串一起使用?

我想使用pythonsargparse模块来解析我的cli参数字符串。这适用于从终端传递的参数,但不适用于给定的字符串。importargparseparser=argparse.ArgumentParser(description='ArgparseTestscript')parser.add_argument("param",help='someparameter')argString='someTestFile'print(argString)args=parser.parse_args(argString)如果我运行这个脚本,我会得到这个输出:~/someTestFileusa