我想将自己的评论和理解发布到代码中，我不希望将这些评论推送到回购协议中。 我不确定这是否可行，目前，我正在创建一个本地笔记本来解释代码库中的一些内容并添加额外的上下文。 那么是否可以在没有以某种方式推送到代码库的地方只添加注释而不是注释或注释？ ...
我目前正在做一个 python 项目，想为我的项目自动生成文档为了自动生成我的文档，我这样做： sphinx-apidoc -f -o source../modules make html 但是当我这样做时，出现以下错误： WARNING: autodoc: failed to import mod ...
我有一个 django 项目，在我的views.py文件中有以下（理论上的）函数，您可以在其中看到get_fullname() function 是嵌套的： 有没有办法通过 Django Admin 文档生成器可视化整个views.py中的嵌套函数？ 或者是否有任何其他产品可以轻松可视化功能之间的链 ...
R 中 Plumber 端点的块注释文档说明了以下有关没有注释的注释的信息： 没有注释的第一行将映射到摘要字段，后续行将映射到描述字段。 我想为我的端点添加更详尽的描述，但结果并不如我所料。 使用以下非常基本的示例对此进行了说明。 运行此 API 会在 Swagger UI 中产生以下结果： ...
如何为一个私有 function 强制使用 rustdoc 文档？ 在我的项目中，有很多私有函数。 我不希望它们成为生成的 rustdoc output （命令cargo doc ）的一部分。 图书馆用户无需阅读这些私有函数。 但是，有一个私有 function 应该是生成的 rustdoc ou ...
我在 Github 存储库上创建了一个 Docusaurus 应用程序，我想向其中添加一些外部资源。 这些来源是来自同一组织的一个或多个 Github 存储库。 有什么办法吗？ 所有部署过程都在 AWS 上使用 Jenkins 管道。 ...
我想在交互式组件内使用来自 javascript 文件的 jsdoc 注释（例如悬停时出现的属性定义），但我找不到这样做的方法，因为 jsdoc 主要用于导出 html 文件。 有没有一种直接的方法可以将文件中的 jsdoc 注释解析为结构化数据，然后我可以在我的 UI 中使用这些数据？ ...
以前任何人使用 doxygen 为颤振项目生成文档，我知道 dartdoc 扩展，但我需要用 doxygen 格式生成它，我发现有人为颤振中的主文件生成了一个文档，但我只是搜索了太多关于如何我做了，一直没找到，希望有人能帮忙 我也尝试过使用 C++ 和 Java，但没有任何结果 ...
所以我有一个docfx.json ，它配置正确并针对正确的目录。 我想知道如何从头开始使用该docfx.json生成网站。 例如，我有一个空白目录，其中只有docfx.json ，我想使用该docfx.json生成所有站点和文档。 与使用docfx init命令一样，但我没有生成空白站点，而是使用现 ...
我的docs/文件夹中有一些 sphinx 文档。 我有一个典型的结构，由一些手写的和动态生成的代码（Python）文档组成。 我想为打开回购协议的人提供一个非常简单的README.rst 。 在该README.rst中，我希望显示 Sphinx 文档的整个目录。 它看起来像这样： 我怎样才能做到 ...
我使用 pdoc3 通过执行以下命令从每个 python 类/函数开头的文档字符串自动生成文档 pdoc3 --html ambit_stochastics生成的文档可以在https://danleonte.github.io/Ambit_Stochastics/index.ZFC35FDC70D5 ...
有什么方法可以修改 asciidoc 文件中源代码块的宽度，而不必水平滚动以显示其内容？ Asciidoc 文档没有说明是否可以更改块的宽度。 ...
是否可以将 a.vsdx Microsoft Visio 文件作为图像包含到源代码中，并使用 doxygen 来编译文档。 如果是这样，如何？ ...
为文档使用扩展属性是一个惊人的想法，但要设置一个文档片段，您必须执行以下操作：EXECUTE sp_addextendedproperty @name = N'MS_Description', @value = N'custom description text', ...
我使用sphinx和sphinx_rtd_theme为我的 package 创建了一个 rtd 主题文档。 index.rst如下： 而src文件大致就是遵循这个思路： conf.py 中的conf.py也如下： 我现在遇到的问题是，下拉菜单无法正常工作。 它们不会出现在侧边栏中，除非我单击一个 ...
我正在开发一个 Django-Rest-React 项目，我需要为我的团队创建测试文档。 我通常知道测试文档应该包含哪些内容，例如清单、测试用例、用例、错误报告等。但是，谁能给我一些关于任何其他项目的提示，以包括或安排文档中的所有内容以使其更具可读性？ ...
我在 Xcode 中创建了一个示例目标 c 框架，我还创建了一个 swift 文件。 这是显示一个 swift 文件和另一个目标 c 类 (NewFramework) 的导航控制器。 当我尝试为框架构建文档时，我只会获得 swift 文件的文档，而不是目标 c 类的文档。 这是 ObjcTemp. ...
我是 Sphinx 文档的初学者。 我想制作 numpy 风格的文档。 因此，我使用了 numpydoc 扩展名。 Numpy 使用pydata主题，但是我选择了furo 。 我知道外观上会有一些差异，但我希望我的页面至少与 numpy 的格式相同，尽管我得到了参数名称和大写类型。 描述没有大写。 ...
有没有办法生成基于 FluentValidator 的文档？ 我需要这样的信息：该字段是NotEmpty(), MaximumLength(40)等。 请指导我 先感谢您！ 编辑：我的意思是获得某个文件的验证。 所以如果验证器看起来像这样： 我想得到第一个字段必须不为空，最大长度为 30 等 ...
我正在使用 sphinx 在 confluence 中构建文档。我能够使用 sphinx 制作 html 文件。 但是当我尝试使用“make confluence”命令连接 confluence 时，它抛出了一个错误 我通过更改汇合密码进行检查并使用 API 令牌进行检查仍然出现错误并且无法与汇 ...