- android - 多次调用 OnPrimaryClipChangedListener
- android - 无法更新 RecyclerView 中的 TextView 字段
- android.database.CursorIndexOutOfBoundsException : Index 0 requested, 光标大小为 0
- android - 使用 AppCompat 时,我们是否需要明确指定其 UI 组件(Spinner、EditText)颜色
我有一个Python项目,它存储在一个文件中,它是一个命令行工具。
我已经成功使用 sphinx 生成了文档,但如何确定我的文件是脚本而不是模块?
最佳答案
有多个选项可用于记录用 Python 编写的命令行工具:
rst2html
转换为 html(我不声称,这个列表是完整的)
这是迄今为止最容易访问的文档形式,因为安装该程序的每个人都可以显示它。
我强烈建议使用 docopt
来解析命令行,因为它为您带来最好的效果 - 在源代码中包含文档字符串(作为模块文档字符串),同时在命令行上。
你可以在SO https://stackoverflow.com/a/23304876/346478中看到我的帖子或者在这里您可以看到项目本身的示例:
"""Usage:
quick_example.py tcp <host> <port> [--timeout=<seconds>]
quick_example.py serial <port> [--baud=9600] [--timeout=<seconds>]
quick_example.py -h | --help | --version
"""
from docopt import docopt
if __name__ == '__main__':
arguments = docopt(__doc__, version='0.1.1rc')
print(arguments)
从命令行运行时:
$ python quick_example.py -h
Usage:
quick_example.py tcp <host> <port> [--timeout=<seconds>]
quick_example.py serial <port> [--baud=9600] [--timeout=<seconds>]
quick_example.py -h | --help | --version
还有其他参数解析器,例如 plac
或 argparse
。我个人最喜欢docopt
。
rst2html
转换为 html编写 README.rst 非常简单,并且有一个优点,即在 github 和 bitbucket 上,您可以在项目自动呈现时获得非常可读的介绍。
它也比 Sphinx 项目简单得多,您不必使用多个文件,只需一个即可。
安装 docutils 时:
$ pip install docutils
你会得到一堆命令,它们可以让你将 README.rst 转换成不错的东西。我在这组命令中使用的唯一命令是 rst2html(在 Windows 上它是 rst2html.py,你必须玩一点才能让它工作,但它绝对值得) )。
为 README.rst
创建 html:
$ rst2html README.rst README.html
我是在我的 vim
编辑器中完成的,它变得更加简单 :!rst2html % %.html
生成 README.rst.html
文件。
我认为 Sphinx 是 reStructuredText 的出色扩展,并用它编写了几本技术小册子 - 它提供了出色的交叉引用语法,我喜欢它。
但对于命令行工具,我认为它太过分了。
有关如何使用 Sphinx 的说明,请参阅他们的精彩文档。
Sphinx 很棒,但对于命令行工具来说似乎有点过分了。
reStructuredText README.rst 应该是任何 Python 项目的必备部分,无论大小如何,当您忘记项目的所有内容时,将您认为方便的所有内容都放在那里。
另一方面,我以 html 形式向用户提供了一组页面,但我不确定他们真正阅读这些页面的频率。人都是懒惰的。
命令行上的帮助选项文档似乎最适合我。目前,您需要帮助(在命令行上输入),您就可以得到它。借助像 docopt
这样的包,它可以与源代码中的文档字符串完美一致。
如果您想对用户进行投资,请教他们less
(或more
)命令,使用这几个热键来搜索/
对于字符串,跳转到下一个匹配项 n
,返回一个匹配项 N
,跳转到顶部 gg
或底部 G
>。 h
或 H
成为您的 friend ,q
成为您的安全漏洞。
享受命令行生活。
关于python - 如何使用 sphinx 为 1 文件 python 项目(脚本,无模块)生成文档?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/23371610/
我在网上搜索但没有找到任何合适的文章解释如何使用 javascript 使用 WCF 服务,尤其是 WebScriptEndpoint。 任何人都可以对此给出任何指导吗? 谢谢 最佳答案 这是一篇关于
我正在编写一个将运行 Linux 命令的 C 程序,例如: cat/etc/passwd | grep 列表 |剪切-c 1-5 我没有任何结果 *这里 parent 等待第一个 child (chi
所以我正在尝试处理文件上传,然后将该文件作为二进制文件存储到数据库中。在我存储它之后,我尝试在给定的 URL 上提供文件。我似乎找不到适合这里的方法。我需要使用数据库,因为我使用 Google 应用引
我正在尝试制作一个宏,将下面的公式添加到单元格中,然后将其拖到整个列中并在 H 列中复制相同的公式 我想在 F 和 H 列中输入公式的数据 Range("F1").formula = "=IF(ISE
问题类似于this one ,但我想使用 OperatorPrecedenceParser 解析带有函数应用程序的表达式在 FParsec . 这是我的 AST: type Expression =
我想通过使用 sequelize 和 node.js 将这个查询更改为代码取决于在哪里 select COUNT(gender) as genderCount from customers where
我正在使用GNU bash,版本5.0.3(1)-发行版(x86_64-pc-linux-gnu),我想知道为什么简单的赋值语句会出现语法错误: #/bin/bash var1=/tmp
这里,为什么我的代码在 IE 中不起作用。我的代码适用于所有浏览器。没有问题。但是当我在 IE 上运行我的项目时,它发现错误。 而且我的 jquery 类和 insertadjacentHTMl 也不
我正在尝试更改标签的innerHTML。我无权访问该表单,因此无法编辑 HTML。标签具有的唯一标识符是“for”属性。 这是输入和标签的结构:
我有一个页面,我可以在其中返回用户帖子,可以使用一些 jquery 代码对这些帖子进行即时评论,在发布新评论后,我在帖子下插入新评论以及删除 按钮。问题是 Delete 按钮在新插入的元素上不起作用,
我有一个大约有 20 列的“管道分隔”文件。我只想使用 sha1sum 散列第一列,它是一个数字,如帐号,并按原样返回其余列。 使用 awk 或 sed 执行此操作的最佳方法是什么? Accounti
我需要将以下内容插入到我的表中...我的用户表有五列 id、用户名、密码、名称、条目。 (我还没有提交任何东西到条目中,我稍后会使用 php 来做)但由于某种原因我不断收到这个错误:#1054 - U
所以我试图有一个输入字段,我可以在其中输入任何字符,但然后将输入的值小写,删除任何非字母数字字符,留下“。”而不是空格。 例如,如果我输入: 地球的 70% 是水,-!*#$^^ & 30% 土地 输
我正在尝试做一些我认为非常简单的事情,但出于某种原因我没有得到想要的结果?我是 javascript 的新手,但对 java 有经验,所以我相信我没有使用某种正确的规则。 这是一个获取输入值、检查选择
我想使用 angularjs 从 mysql 数据库加载数据。 这就是应用程序的工作原理;用户登录,他们的用户名存储在 cookie 中。该用户名显示在主页上 我想获取这个值并通过 angularjs
我正在使用 autoLayout,我想在 UITableViewCell 上放置一个 UIlabel,它应该始终位于单元格的右侧和右侧的中心。 这就是我想要实现的目标 所以在这里你可以看到我正在谈论的
我需要与 MySql 等效的 elasticsearch 查询。我的 sql 查询: SELECT DISTINCT t.product_id AS id FROM tbl_sup_price t
我正在实现代码以使用 JSON。 func setup() { if let flickrURL = NSURL(string: "https://api.flickr.com/
我尝试使用for循环声明变量,然后测试cols和rols是否相同。如果是,它将运行递归函数。但是,我在 javascript 中执行 do 时遇到问题。有人可以帮忙吗? 现在,在比较 col.1 和
我举了一个我正在处理的问题的简短示例。 HTML代码: 1 2 3 CSS 代码: .BB a:hover{ color: #000; } .BB > li:after {
我是一名优秀的程序员,十分优秀!