草庐IT

sphinx-argparse

全部标签

python - argparse (python) 是否支持互斥的参数组?

如果我有参数'-a','-b','-c','-d',与add_mutually_exclusive_group()函数我的程序将只需要使用其中一个。有没有办法将它结合起来,以便程序只接受'-a999-b999'或'-c999-d999'?编辑:添加一个简单的程序更清晰:>>>parser=argparse.ArgumentParser()>>>group=parser.add_mutually_exclusive_group()>>>group.add_argument('-a')>>>group.add_argument('-b')>>>group.add_argument('-c'

python - 使用 sphinx 自动记录 python 类、模块

我已经安装了Sphinx为了记录我正在研究的一些Python模块和类。虽然标记语言看起来很不错,但我还没有设法自动记录Python代码。基本上,我有以下Python模块:SegLib.py还有一个名为Seg的类。我想在生成的Sphinx文档中显示类和模块的文档字符串,并在其中添加更多格式化文本。我的index.rst看起来像这样:Contents:..toctree:::maxdepth:2chapter1.rst和chapter1.rst:Thisisaheader================Sometext,*italictext*,**boldtext***bulletedl

python - Sphinx 文档中的条件输出

我正在用Sphinx编写一些文档我只想为HTML文档打印出特定的文本block,而不是为LaTeX文档打印。有些东西告诉我我应该能够用sphinx.ext.ifconfig做到这一点,但我不知道怎么做。有谁知道怎么做? 最佳答案 不需要扩展。只需使用only指令。(旧链接,来自2010年的原始帖子)https://web.archive.org/web/20100129001557/http://sphinx.pocoo.org/markup/misc.html#including-content-based-on-tags(最新链

python - 如何使用 Sphinx 记录异常?

我似乎不知道如何使用Sphinx记录异常。我尝试了以下方法:defsome_funct():""":raises:ExceptionType:Somemulti-lineexceptiondescription."""defsome_funct():""":raises:ExceptionType,Somemulti-lineexceptiondescription."""defsome_funct():""":raisesExceptionType:Somemulti-lineexceptiondescription."""defsome_funct():""":raises:Exc

python - argparse 模块在 Python 中不起作用

我正在尝试让argparse模块在Python中工作。我的问题是,在全新安装时,我得到以下信息:File"test.py",line3,inimportargparseFile"/home/jon/Pythons/realmine/argparse.py",line3,inparser=argparse.ArgumentParser(description='Shortsampleapp')AttributeError:'module'objecthasnoattribute'ArgumentParser'test.py是:importargparse显然,我错过了一些东西。有人可以帮

python - 结合来自多个子项目的 Sphinx 文档 : Handling indices, 同步配置等

我们有一个用(优秀的)Sphinx记录的多模块项目。我们的设置与describedonthemailinglist不同。.总的来说这个worksgreat!但我们对此有一些疑问:子模块目录将包括索引链接。充其量这些将链接到错误的索引。(在最坏的情况下,这似乎会触发Sphinx中的错误,但我使用的是开发版本,所以这是合理的)。有没有办法只为最顶层的目录树生成索引链接?是否有让Sphinx配置在多个项目之间保持同步的最佳做法?我可以想象围绕fromcommon_configimport*一起破解一些东西,但对其他方法感到好奇。虽然我们正在处理它,但邮件列表帖子中提出的问题(替代符号链接(s

python - docutils 和 Sphinx 是什么关系?

似乎有大量的Python文档工具。我遇到的另一个是epydoc。似乎Sphinx是事实上的标准,因为它用于生成官方Python文档。有人可以帮我整理一下Python文档工具的当前状态吗? 最佳答案 epydoc和Sphinx是不同类型的工具。它们的相同之处在于:两者都使用ReST通过docutils.两者都非常注重Python风格两者都可以生成HTML和PDF文档他们的关注点不同。Epydoc专注于API(开发人员)文档。使用Epydoc,您可以更快地获得更多结果。你把它指向你的源代码,你就会得到一些东西。这就是我想要的API文档工

python - Python 和 argparse 的多个位置参数

我正在尝试使用argparse来解析我正在处理的程序的命令行参数。本质上,我需要支持在可选参数中传播的多个位置参数,但不能让argparse在这种情况下工作。在实际程序中,我使用的是自定义操作(每次找到位置参数时,我都需要存储命名空间的快照),但我遇到的问题可以通过append复制>行动:>>>importargparse>>>parser=argparse.ArgumentParser()>>>parser.add_argument('-a',action='store_true')>>>parser.add_argument('-b',action='store_true')>>>

python - 如何配置 Sphinx 以有条件地排除某些页面?

使用Sphinx生成文档时,我希望能够生成我的文档的两个版本:一个包含所有内容,一个仅包含一组特定页面。实现这一目标的最佳方法是什么?我可以编写一个构建脚本来移动文件来实现这一点,但如果有一种方法可以告诉sphinx在特定构建期间排除或包含特定文档,那就太好了。 最佳答案 也许我的回答来的有点晚,但我设法通过excludepatternsintheconfigfile用Sphinx做到了这一点.我的文档部分供用户使用,部分供管理员使用。有些页面的文件名包含单词admin,和你一样,我想构建两个版本:一个包含所有内容(管理员文档),一

Python argparse required=True 但 --version 功能?

在我的所有脚本中,我使用标准标志--help和--version,但是我似乎无法弄清楚如何制作--带有parser.add_argument(...,required=True)的版本。importsys,os,argparseparser=argparse.ArgumentParser(description='Howtoget--versiontowork?')parser.add_argument('--version',action='store_true',help='printversioninformation')parser.add_argument('-H','--h