标签: documentation-generation

Markdown 或其他简单标记语言中的条件逻辑?

我正在寻找一种类似 Markdown 的语言的实现,它允许我在文档中嵌入“条件逻辑”。

我想该文档会类似于:

This text should be included in all processed versions of the document

[platform==foo]
This is an example for platform Foo

[platform==bar]
This is an example for platform Bar
Run Code Online (Sandbox Code Playgroud)

然后可以通过将参数传递给处理脚本来生成文档的不同版本:

./process-markdown --platform=foo
Run Code Online (Sandbox Code Playgroud)

我的谷歌搜索没有返回任何接近于此的内容,尽管我觉得软件文档中必须存在这样的东西。

documentation markdown documentation-generation

5
推荐指数
1
解决办法
1万
查看次数

Python 中是否有相当于 Ruby's Yard 的东西?

我同时使用 Python 和 Ruby,而且我真的很喜欢 Ruby's Yard 文档服务器:

http://yardoc.org/

我想知道Python世界里是否有类似的东西?“pydoc -p”确实很旧,丑陋,使用起来一点也不舒服,而且看起来Sphinx和Epydoc不支持服务器模式。

你知道有什么等价的吗?

谢谢

ruby python documentation-generation yard

5
推荐指数
1
解决办法
1321
查看次数

Doxygen:空详细说明

Context - 用于生成 RTF 文档的 C 代码的 Doxygen 工具。

在模块/组的文档中,即使没有为某些特定模块/组提供详细描述,我们也会获得标题“详细描述”。

在生成的 RTF 文档中,这看起来很难看。是否可以去掉这个空的详细描述部分?

我尝试过"ALWAYS_DETAILED_SEC = NO",但它不起作用。我不能这样做"HIDE_UNDOC_MEMBERS = YES",因为组/模块包含已记录的成员(结构、函数...)。

documentation rtf doxygen documentation-generation

5
推荐指数
1
解决办法
3927
查看次数

Doxygen 不为全局函数生成文档

我有一个 C 头文件,其中声明了许多方法,所有这些方法都包含有效的 doxygen 标记来生成文档,但是 doxygen 无法为这些方法创建任何文档,除非我将其设置EXTRACT_ALL为 true,但即使在这种情况下,方法只出现在头文件的文档中...我想要一个集合点“函数”,其中包含方法列表,我可以在其中单击它们...这可能吗?(我的输出针对 C/PHP 进行了优化,但是将其设置为其他内容根本没有帮助)...

c doxygen documentation-generation

5
推荐指数
1
解决办法
3763
查看次数

JSDoc:如何避免属性/getter 的重复文档?

我目前正在使用 JSDoc 记录我的一个 API。虽然这很有效,但真正让我烦恼的一件事是重复文档的出现。一个常见的例子是属性及其 getter 的文档:

function AClass() {
    /**
     * The current state of the object. Determines wether this object has been initialized yet.
     * @type {String}
     * @private
     */
    this._state = "initalized";
}

/**
 * Returns the current state of the object, which determines if the object has been initalized yet.
 * @return {String} The current state of the object
 */
AnObject.prototype.getState = function() {
    return this._state;
}
Run Code Online (Sandbox Code Playgroud)

我想每个人都在这里看到了这个问题。该属性实际上被记录了三遍(私有属性本身、getter 方法描述和方法的返回值)。简单地将方法的描述更改为类似的Returns the state内容并不是一个真正的选择,因为我通常在文档输出中隐藏私有属性。

我对此类情况是否有最佳实践以及其他人如何处理很感兴趣。作为一个痴迷于 DRY 的人,似乎应该有更好的选择来处理这些情况。

javascript documentation documentation-generation jsdoc jsdoc3

5
推荐指数
1
解决办法
1542
查看次数

Angular 2:从模板生成单词和 pdf

这里我又回来了。

我有一个包含一些字段的单词模板要填充,我想在我的 Angular 2 应用程序中使用这个模板来生成填充了字段(带有对象)的相同单词。

当我从数据库中获取数据时,我绝对需要使用来自服务的对象,并且我需要使用特定的模板。

我看到有一些 API,如 office-js、jsPDF 等……但我不知道该选择哪一个,也不知道如何使用它们。

大家有什么推荐吗?

先感谢您 !

pdf-generation ms-word documentation-generation angular

5
推荐指数
0
解决办法
2627
查看次数

Antora顶部导航栏定制

我的问题很简单,尽管我在文档中找不到任何指向它的内容。

我正在使用 Antora 中的默认生成器为项目生成文档,但我无法弄清楚如何自定义顶部导航栏、右侧的项目,这些项目有一些默认值。

既然网站已经生成,我应该在哪里更改,或者如何更改这些项目?我不想在那里列出这些项目。

documentation-generation asciidoctor antora

5
推荐指数
2
解决办法
941
查看次数

使用 roxygen2 在单个文档对象中记录多个数据集

我正在寻找相当于@describeIn它允许我为多个 R 数据对象创建单个文档对象。

\n\n

我本来希望这样的事情:

\n\n
#\' Tree Distances\n#\' \n#\' These datasets contain the distances between sets\n#\' of 10-tip, 11-tip and 12-tip trees.\n#\' \n#\' @name treeDistances\n#\' @keywords datasets\n"treeDistances10"\n"treeDistances11"\n"treeDistances12"\n
Run Code Online (Sandbox Code Playgroud)\n\n

将生成一个适用于所有三个treeDistances##对象的手册页,类似于使用@describeIn treeDistances Distances between 11-tip trees.

\n\n

我注意到添加@aliases treeDistance11 treeDistance12文档页面与数据对象相关联,但没有引用“使用”部分 \xe2\x80\x93 中的对象,但我相信有更合适的方法来执行此操作?

\n

documentation r dataset documentation-generation roxygen2

5
推荐指数
1
解决办法
628
查看次数

在 Docusaurus 中包含源文件中的特定代码行

我目前正在决定是否将我的开发人员文档从 Sphinx 迁移到 Docusaurus。阻碍我的一件事是 Docusaurus(实际上是一般的 Markdown)不支持从其他文件中提取特定的文本行。

Sphinx (reStructuredText) 允许您在另一个文件上的和标记include之间发送文本- 对于从功能齐全的脚本中提取代码片段非常有用:start-afterend-before

.. include:: ./scripts/matts_script.py
   :start-after: # marker_1
   :end-before: # marker_2
Run Code Online (Sandbox Code Playgroud)

那么 Docusaurus 有办法做到这一点吗?有人做过吗?我想也许可以利用 MDX 和 JSX,但这实际上只是一个猜测。

markdown documentation-generation file-inclusion docusaurus

5
推荐指数
0
解决办法
181
查看次数

列出emacs中的所有顶级全局变量

主要是为了我自己的启发,我试图列出当前Emacs会话中加载的所有全局变量.我正在考虑做的是生成一个包含所有列出的函数的HTML文件.当然,还有用的是定义函数var等的文件.

有没有内置到emacs中的任何东西可以提供帮助?

L-

emacs elisp documentation-generation globals

4
推荐指数
1
解决办法
229
查看次数