个人中心
文章发布
退出
作者热门文章
- android - 多次调用 OnPrimaryClipChangedListener
- android - 无法更新 RecyclerView 中的 TextView 字段
- android.database.CursorIndexOutOfBoundsException : Index 0 requested, 光标大小为 0
- android - 使用 AppCompat 时，我们是否需要明确指定其 UI 组件(Spinner、EditText)颜色
24
4
我在尝试找出为 Django 项目实现自动文档生成的最佳方法时遇到了一些困难
我的项目结构类似于以下内容:
myproj/ # project root
|- docs/ # docs root
|- myproj/ # package root
|- app1/
|- app2/
|- app3/
utils.py
...
我想为包根目录下的所有内容自动生成文档 - 最初开始使用 sphinx-apidoc，但后来读到一些暗示我应该改用自动摘要但一直无法查找任何概述这两个选项之间区别的信息。
最佳答案
对于其他努力解决这个问题的人来说，这是我终于找到的帮助我消除困惑的指南:
https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-ii-6/
简而言之，使用自动摘要
关于python - sphinx-apidoc 与自动摘要，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/53099934/
24
4
0
我正在使用 docstrings 来记录 python 代码，并使用 sphinx-autodoc 来生成 apidoc HTML。我的包的结构如下:mainpackage.subpackage.mo
嘿，我正在尝试从我的 apiDoc 中删除/隐藏示例请求表单。我没有在我的 package.json 配置上使用 sampleUrl 标签，在 api_porject.json 上这个属性设置为 fa
我在尝试找出为 Django 项目实现自动文档生成的最佳方法时遇到了一些困难 我的项目结构类似于以下内容: myproj/ # project root |- docs/
我对 sphinx 还很陌生，我正在尝试将其用作我项目的 API 引用。也许在那之后也作为项目文档。 我使用这两个命令生成它 sphinx-apidoc -e -o doc/api tracer sp
我目前正在 L5.5 上工作，为了生成 api 文档我已经安装了 this包，现在我不需要那个包我决定卸载它但是在卸载时我得到了这个错误。 Generating optimized autoload
我使用 apiDoc 来记录 Java，并希望使用 @apiParam 来表明输入参数可以是不同类型。例如:类型可能是Map、Collection、Set、List等，我该怎么办？ 最佳答案 尝试以下
使用sphinx-apidoc生成.rst文件时，输出结果不包含任何标签: dessn.examples package ====================== .. automodule::
我正在使用 yiisoft/yii2-apidoc (#0.2.4) 为在 yii2 中编写的项目构建文档。我已经构建了一个 shell 脚本来发布文档，当我只包含项目文件和我自己的 cms 代码库时
我最近尝试使用 sphinx-apidoc来自 Sphinx帮助从 Python 项目的 API 生成 Sphinx 特定的 reStructuredText。 但是，我得到的结果是: 有人知道我是否
我有一个 nodejs 项目，其中包含许多请求并由 apiDoc 详细记录，我想从中创建一个 Postman 集合! > example: /** * @api {GET} config/u
我有以下两个类: class Test1(): """Test1()""" def fn_test1(): """fn_test1 """ print
已结束。此问题正在寻求书籍、工具、软件库等的推荐。它不满足Stack Overflow guidelines 。目前不接受答案。 我们不允许提出寻求书籍、工具、软件库等推荐的问题。您可以编辑问题，以便
我已阅读 apidoc.js 文档，但我遇到了困境。我不太清楚 @apiParam 和 @apiSucces 之间的区别，文档没有正确解释它们的真正作用。例如，我有一个 get 和一个 put，其中包
我一直致力于 PyQt5 的一个项目(可在此处找到:https://github.com/MaVCArt/StyledPyQt5)，它使用包结构来使导入更合乎逻辑。到目前为止，我在使用 Sphinx
所以我的 python 源文件在两个不同的目录中:- 例如 ~/work/myproject ~/.virtualenvs/myproject 如何使用 sphinx-apidoc 递归地查看两个目录
我正在尝试清理我的 python 代码文档，并决定使用 sphinx-doc因为它看起来不错。我喜欢使用如下标签引用其他类和方法: :class:`mymodule.MyClass` About my
当我运行 sphinx-apidoc 然后 make html 时，它会生成包含“Subpackages”和“Submodules”部分以及“module”和“package”的文档页面目录 (TOC
过去有几个关于这个主题的帖子声称 Sphinx 根本不支持这个。我有我的疑虑，但要么它已经更新，要么它的文档被很好地隐藏了，因为这是网站上的一个链接，另有说明: http://www.sphinx-d
我想从 SwaggerUI 中排除“默认”部分 - 我在其中保留不想公开的路由。我知道在 Nelmio Apidoc 的 2.x 版本中，config.yml 中有一个名为 exclude_secti
我正在使用 http://apidocjs.com/为我正在构建的 Express.js API 创建公共(public)文档。我的问题是，如何使用 Express.js 来路由和提供文档？ 这是我的
我是一名优秀的程序员,十分优秀！