documentation-generation 相关问题

文档生成器是一种编程工具,它从一组特别注释的源代码文件(在某些情况下是二进制文件)中为程序员(API文档)或最终用户(最终用户指南)或两者生成文档。

生成gRPC API文档的方法(专门针对Java、Spring Boot)

我想在我的 Spring Boot 应用程序中记录 gRPC API。我浏览过的网络资源建议将端点映射到 REST,然后生成文档...

回答 1 投票 0

Sphinx 警告:无法从模块 `pythontemplate` 导入 test.test_adder

上下文 创建 root_dir/docs/source/conf.py 并自动为 root_dir/src (和 root_dir/test/)目录(及其子目录)中的每个 .py 文件生成 .rst 文件后,我

回答 1 投票 0

源代码文档工具

有人可以推荐一款 VB.NET 10 的源代码文档工具吗? 谢谢。

回答 5 投票 0

有没有办法在Quarkus中从application.properties生成asciidocs?

有没有办法在Quarkus中自动从application.properties生成asciidocs? 假设我有一个带有以下键的 application.properties quarkus.lambda.预期异常 夸库斯。

回答 1 投票 0

自动生成所有Python包内容的文档

我正在尝试使用 Sphinx 为我的代码库自动生成基本文档。但是,我很难指示 Sphinx 递归扫描我的文件。 我有一个带有文件夹的 Python 代码库

回答 5 投票 0

尽管在conf.py中排除了,Sphinx仍然为测试文件夹生成文档

我正在使用 Sphinx 为我的 Python 项目生成文档,并且我想将测试文件夹排除在生成的文档中之外。我已将“**/tests/*”添加到

回答 1 投票 0

如何记录 makefile?

有没有办法在 Makefile 中编写“标准”注释,以便稍后将它们提供给类似 Doxygen 的程序,从而输出漂亮的(例如 HTML 或 man)文档?我想要一个清晰的ove...

回答 9 投票 0

Doxygen @ref 带有链接的自定义文本

我该如何命名 Doxygen @ref 标签? 我已经尝试过以下方法: 有关更多信息,请参阅@ref hello_world hello 输出如下: 请参阅 hello_world hello 了解更多信息 哪里

回答 1 投票 0

出于文档原因生成所有有效 BBCode 实体的列表

我已经成功地集成了 BBCode,但我想知道如果我想动态列出所有允许/接受的 BBCode - 我怎样才能做到这一点? (因为手动操作可能很乏味

回答 1 投票 0

如何自定义Docfx文档(主题或模板)?

我刚刚开始使用Docfx并设置了一些基本的概念文档。现在我想对主题进行一些调整(公司徽标,也许一些字体更改等)小东西。 官方

回答 2 投票 0

如何使用 Swagger 以及 Nest.js API 和 SPA 之间共享的 DTO?

我有一个带有 Nest.js API 和 Angular SPA 的项目。 SPA 用于与 API 通信的 DTO 位于一个名为 Models 的单独项目中,我将其用作依赖项。这样一来,我...

回答 1 投票 0

Sphinx 是否已经适合 C++ 文档? [已关闭]

我想尝试使用 C++ 的新项目的文档生成器。我认为我的选择是 Doxygen 或 Sphinx。由于我有一个 Python 项目,我想使用 Sphinx,所以我想知道...

回答 2 投票 0

如何生成Visual Studio 2022文档?

我正在尝试在 C++ 项目(VS 2022 Community)中使用 xml 标签在 、 等注释中生成文档。我正在搜索项目设置,配置输出... 我正在尝试在 c++ 项目(VS 2022 社区) 中使用 xml 标签在注释中生成文档,如 、 等。我正在搜索项目设置、配置的输出文件和重建项目。但结果为零。我找不到输出文件。它到底生成了吗?无法理解他在哪里。我知道还有几个程序/插件制作文档,但我想尝试嵌入服务。输出文件设置为 $(OutDir)$(TargetName).xml 解决了! =) 因此,要生成文档,您需要在 Project->Settings->C/C++ 启用选项 Create XML-documentaion file 文件路径的默认设置有效。其他选项位于项目->设置->XML 文档生成 啊……好难找啊。官方文档中没有此主题的链接) 将其添加到您的 .csproj 文件中 <PropertyGroup> <GenerateDocumentationFile>true</GenerateDocumentationFile> </PropertyGroup>

回答 2 投票 0

如何像在 IDE 中那样为内部文档设置颜色格式?

我在一家中型公司工作,有很多初级员工,在编写流程的内部文档时我希望能够轻松复制代码,所以不要使用任何图像,但代码是彩色的.. .

回答 2 投票 0

对网站文档生成器有什么建议吗?

上下文: 我是一名新的 IT 管理员,对于我支持的团队,我希望建立一个良好的文档中心,让他们可以轻松找到他们想要的内容。 我想要的是 : 我希望找到一个 github 存储库...

回答 1 投票 0

如何使用 Pydoc 创建文档?

我正在尝试从我的模块中创建一个文档。我在 Windows 7 中使用 Python 3.2.3 从命令行使用 pydoc: python "\pydoc.py" -w myModule 这导致我的外壳...

回答 5 投票 0

Postgresql 数据库文档

我正在寻找一个免费工具,它可以将数据库模式、表、列、键、索引的文档生成为 PDF 或 HTML 格式,例如商业工具“Toad Data Modeler”。 ...

回答 2 投票 0

如何从 Doxygen 获取单个 PDF 文档?

当我生成 PDF 格式的 Doxygen 文档时,我会得到大量不同的文件,每个文件中都有一个图表。 是否可以获得一个 PDF 文档,以一本书的形式组织,大致如

回答 7 投票 0

如何引用 Docusaurus 根文件夹之外的文件

我和我的团队正在寻求实现一个文档系统,该系统允许工程师将 markdown 文件放入每个服务根目录的指定文件夹中。因为我们是在星期一...

回答 1 投票 0

Jupyther Shift-Tab 不适用于 Pandas

考虑执行以下命令: 将 pandas 导入为 pd df = pd.DataFrame({'x':[1,2,3]}) 然后将光标放在 df.sort() 的括号内并按 shift-tab 不会打开文档...

回答 1 投票 0

© www.soinside.com 2019 - 2024. All rights reserved.