documentation-generation 相关问题

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

documentation-generation sandcastle html-help

回答 1 投票 0

带有MKDocstrings的子文件夹中的无__init__.py的加生成降价文件

这是我的项目结构： - 软件包 -PKG1 ---传票 ---- WRKPKG1 ------file1.py ---- WRKPKG2 ------file2.py ------__init__.py mkdocs.yaml：插件：搜索景点＃lightbo ...

python documentation-generation mkdocs mkdocstrings

回答 1 投票 0

如何在Python中查找库的函数？

我刚刚安装了这个抓取 Twitter 数据的库：https://github.com/kennethreitz/twitter-scraper 我想找出该库的功能和方法，以便我可以开始与

python documentation-generation inspect pydoc

回答 2 投票 0

如何格式化 Jenkins 共享库文档

我已经成功构建了一个 Jenkins 共享库。在 vars 文件夹中有 lbrCall.groovy lbrCall.txt 我缺少有关格式化 lbrCall.txt 文档的内容。文档...

jenkins shared-libraries documentation documentation-generation

回答 1 投票 0

Pandoc HTML 阅读器，读取 <title> 标签，作为 pandoc 对象标头？标签感兴趣，但似乎 HTML 的默认 pandoc Reader 确实...</desc> <question vote="1"> 我正在为 <pre><code>.html</code></pre> 中存储的不同文档做一个自定义解析器。我对解析文档的 <pre><code><title></code></pre> 标签感兴趣，但似乎 HTML 的默认 <pre><code>pandoc Reader</code></pre> 不解析这样的标签。 有这个简单的例子 <pre><code>input.html</code></pre> <pre><code><!DOCTYPE html> <html> <head> <title>My Research Article</title> </head> <body> <h1>Introduction</h1> This is the introduction to my research article. </body> </html> </code></pre> 做<pre><code>pandoc input.html -t native</code></pre> 我明白了 <pre><code>[ Header 1 ( "introduction" , [] , [] ) [ Str "Introduction" ] , Para [ Str "This" , Space , Str "is" , Space , Str "the" , Space , Str "introduction" , Space , Str "to" , Space , Str "my" , Space , Str "research" , Space , Str "article." ] ] </code></pre> 所以我看到默认情况下不读取 <pre><code><title></code></pre> 标签。有没有办法使用 <pre><code>lua</code></pre> 语法实现自定义阅读器来识别这样的标签？并将其读取为 Pandoc 对象 <pre><code>Header</code></pre> ? </question> <answer tick="false" vote="0"> Pandoc 实际上确实解析了 <pre><code>title</code></pre>，但您缺少 <pre><code>-s</code></pre> 或 <pre><code>--standalone</code></pre> 标志。尝试： <pre><code>pandoc -f html -t native -s </code></pre> </answer> </body></html>

我正在为 .html 中存储的不同文档做一个自定义解析器。我对解析文档的标签感兴趣，但似乎 HTML 的默认 pandoc Reader 确实...</desc> <question vote="1"> 我正在为 <pre><code>.html</code></pre> 中存储的不同文档做一个自定义解析器。我对解析文档的 <pre><code><title></code></pre> 标签感兴趣，但似乎 HTML 的默认 <pre><code>pandoc Reader</code></pre> 不解析这样的标签。 有这个简单的例子 <pre><code>input.html</code></pre> <pre><code><!DOCTYPE html> <html> <head> <title>My Research Article</title> </head> <body> <h1>Introduction</h1> This is the introduction to my research article. </body> </html> </code></pre> 做<pre><code>pandoc input.html -t native</code></pre> 我明白了 <pre><code>[ Header 1 ( "introduction" , [] , [] ) [ Str "Introduction" ] , Para [ Str "This" , Space , Str "is" , Space , Str "the" , Space , Str "introduction" , Space , Str "to" , Space , Str "my" , Space , Str "research" , Space , Str "article." ] ] </code></pre> 所以我看到默认情况下不读取 <pre><code><title></code></pre> 标签。有没有办法使用 <pre><code>lua</code></pre> 语法实现自定义阅读器来识别这样的标签？并将其读取为 Pandoc 对象 <pre><code>Header</code></pre> ? </question> <answer tick="false" vote="0"> Pandoc 实际上确实解析了 <pre><code>title</code></pre>，但您缺少 <pre><code>-s</code></pre> 或 <pre><code>--standalone</code></pre> 标志。尝试： <pre><code>pandoc -f html -t native -s </code></pre> </answer> </body></html>

html parsing pandoc documentation-generation reader

回答 0 投票 0

为什么 C# 编译器在 XML 文档中包含非公共成员？

使用 csc.exe 编译源代码时，可以使用 /doc 选项将源文件中的 xml 文档注释保存到外部 xml 文件。我想知道的是为什么

c# documentation documentation-generation xml-documentation

回答 2 投票 0

如何使用 %(before_notes)s 和 %(after_notes)s 自动填充文档

我为一个研究项目编写了一个模块，该模块实现了一些概率分布作为 Scipy 的 rv_continuous 类的子类。现在我想为我的 modu 创建一些文档...

scipy documentation-generation api-documentation

回答 1 投票 0

是否可以告诉 jsdoc 在与源代码分开的文件中查找该代码的文档？

我希望内联注释尽可能短，因为我的经验是超过 3 或 4 行的注释往往会被掩盖，从而产生很多不必要的“阅读手册...

javascript documentation-generation jsdoc

回答 3 投票 0

如何解析位于外部库中的java类？

我目前正在开发一个插件，可以从枚举创建降价表。例如，如果我有这个枚举：枚举 MyEnum { /** * 1 的文档 */ 我的常数1(1), MYCONSTANT2(...

maven maven-plugin documentation-generation maven-plugin-development

回答 1 投票 0

如何使用Sphinx生成Microsoft Word文档

Sphinx 支持几种输出格式：多个 HTML 文件（带有 html 或 dirhtml） Latex 对于创建 .pdf 或 .ps 非常有用文本如何获取 Microsoft Word 文件中的输出？与

ms-word python-sphinx documentation-generation

回答 8 投票 0

缺少使用 AsyncAPI 生成的示例有效负载

我开始使用 AsyncAPI 为我的异步 Websocket 协议生成文档。我使用 AsyncAPI Studio 快速迭代我的文档，并使用 asyncapi/cli 和 docker 来实际

asynchronous yaml documentation documentation-generation asyncapi

回答 1 投票 0

在 pdoc 文档中排除装饰器

我想使用 pdoc 从我的 API 文档中排除装饰器。我有什么可能的方法可以实现这一目标吗？举个例子，如果我写： @xl_func(“废话”，“废话”) 定义

python documentation-generation pdoc

回答 1 投票 0

JSDoc：返回对象结构

我如何告诉 JSDoc 返回的对象的结构。我找到了 @return {{field1: type, field2: type, ...}} 描述语法并尝试了它： /** * 返回坐标...

javascript documentation-generation jsdoc code-documentation jsdoc3

回答 3 投票 0

Sphinx autoflask 仅为所有端点制作一页

我继承了一个项目，并且是第一次使用Sphinx。我有一个 app.py ，其中包含我所有的 api 端点，当您制作文档时，您将所有 api.add_resources 包装在一个 func 中...

python flask python-sphinx documentation-generation

回答 1 投票 0

运行 dotnet swagger tofile 命令会导致解决方案开始运行

我正在运行一个解决方案，并将以下内容添加到 csproj 以构建自定义 swagger 文档 ` 我正在运行一个解决方案，并将以下内容添加到 csproj 以构建自定义 swagger 文档 ` </PropertyGroup> <Exec Command="dotnet tool restore" /> <Exec Command="dotnet swagger tofile --output myoutputfile myawesomecode.dll v1 " /> ` 当我尝试运行构建时，工具恢复成功，但是解决方案开始运行而不是编写文档。这是一个问题，因为我的服务需要其他几个服务（例如许可）才能运行。在我的公司，我们有另一个项目没有遇到这个问题，并且似乎没有额外的代码来阻止它运行。我的问题是如何在不运行源代码的情况下创建 swagger 文档？经过 4 天的搜索，我发现了我的代码库的问题，这要归功于 github 存储库上的开放票证。 https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2290 这解释了已经实施的 swashbuckle CLI 和最小托管模型存在一个未解决的问题。我的 Program.cs 最初看起来像这样： public class Program { public static async Task Main() { var builder = WebApplication.CreateBuilder(args); builder.Service.AddSingleton<ISomeOtherService, SomeOtherService>(); builder.Services.AddSwaggerGen(options => //custom swagger gen ); builder.Services.AddMvc(); //etc var app = builder.Build(); if (env.IsDevelopment()) { app.UseSwagger(); app.UseSwaggerUI(); } await app.RunAsync(); } } 问题在于 dotnet swagger tofile 代码正在使用反射或其他进程寻找名为“Startup.cs”的类，以便能够加载 swagger 文档。当 Startup.cs 不存在时，dotnet swagger 运行程序 main。为了确认这一点，我使用名为 Startup.cs 的类（成功运行）运行了代码两次，第二次名为 SomethingElse.cs（启动了我的应用程序）。为了解决这个问题，我必须引入一个类，它必须从 Startup 开始，如下所示： public class Startup(IConfiguration configuration, IWebHostEnvironment enviroment) { public IConfiguration Configuration { get; } = configuration; public IWebHostEnvironment Environment { get; } = enviroment; public void ConfigureServices(IServiceCollection services) { service.AddSingleton<ISomeOtherService, SomeOtherService>(); services.AddSwaggerGen(options => //custom swagger gen ); services.AddMvc(); //etc } public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseSwagger(); app.UseSwaggerUI(); } } } public class Program { public static async Task Main() { var builder = WebApplication.CreateBuilder(args); var startup = new Startup(builder.Configuration, builder.Environment); startup.ConfigureServices(builder.Services); var app = builder.Build(); startup.Configure(app, builder.Environment); await app.RunAsync(); } } 在最小托管模型的官方文档上，代码示例引用了 Startup.cs 类，如下所示：但是 swagger 文档没有提到没有 Startup.cs 会导致任何问题。

.net-core swagger documentation-generation

回答 1 投票 0

在 sphinx 中构建反映项目文件夹结构的目录

我想为Python项目自动生成文档。我设法获得了一个与 sphinx 一起使用的准系统管道，但输出不是很漂亮，我希望得到一些关于如何...

python-sphinx documentation-generation autodoc

回答 1 投票 0

在 sphinx 文档中选择性地包含私有成员函数

我想为Python项目自动生成文档。我设法获得了一个与 sphinx 一起使用的准系统管道，但输出目前几乎包括所有内容，我想要更多

python-sphinx documentation-generation private-members

回答 1 投票 0

为我们的 JavaScript 库 API 编写文档 [已关闭]

我需要为我们的 JavaScript 库 API 编写文档并将其发布为 HTML（如 jQuery API 网站等）。我认为有两种方法可以完成这项任务。写下评论...