18得票1回答
谷歌使用哪种文档生成器?

谷歌对其所有API都有统一的文档。我想知道它使用了哪个文档生成器,并且它是否可供公共使用。它具有良好的目录和其他功能,而且代码看起来很整洁。 有人可以更详细地解释一下吗?

17得票1回答
使用三重引号在Jupyter Notebook中生成Python自动文档字符串

我正在使用Python的Jupyter笔记本工作,并尝试使用自动文档功能生成如下所示的文档字符串。在像PyCharm这样的IDE中,函数下方三引号+Enter会生成如下所示的文档字符串。def test_function(df: pd.DataFrame, probs: dict) ->...

17得票1回答
安卓中自定义XML样式属性是否有文档标准?

我能够记录下我Android项目中的几乎所有内容,并为它们生成漂亮的API参考文档。 唯一例外的是XML文件,尤其是包含可定制属性的属性文件。 例如,res/values/attrs.xml 的一部分:<resources> <declare-styleable ...

17得票6回答
如何为Django项目构建Sphinx文档

我有一个Django项目,使用reST在docstrings中记录文档来实现以下功能: 帮助IDE中的对话框 后来使用Sphinx构建HTML文档 我的文档在IDE(PyCharm)中正常显示,但我无法配置Sphinx来生成HTML文档。 这是我的项目结构+-------------...

17得票2回答
Doxygen中是否有类似于@inheritDoc的等效命令?

我知道 Javadoc 可以编译 {@inheritDoc},但是 Doxygen 该怎么做呢?

17得票4回答
如何防止GitHub Pages的“自动生成器”在重新生成网站之前删除所有内容?

我为我的小项目创建了一个精美的GitHub Pages 网站,并将其他页面添加到gh-pages分支中。 我的问题是,每次我从“设置=>自动页面生成器”重新生成网站时,所有内容都会被清除,我必须手动恢复文件。 有没有办法防止或解决这个问题? 如果自动生成器只覆盖而不删除现有文件,那就好多了。

16得票3回答
从TypeScript生成JSON模式

我正在尝试创建一个TypeScript文档生成器,但为了实现这一目标,我需要将TypeScript文件解析为更易于阅读的格式。 EX:"Command": { "description": "A command object for the command handler", ...

16得票1回答
Sphinx-apidoc在构建Django HTML时出现`django.core.exceptions.AppRegistryNotReady`错误

问题背景: 我想在我的Django项目中使用Sphinx编写文档,并利用我的Django代码注释自动创建文档。 现在我有一个Django(1.9)项目,文件结构如下: myproject/ myproject/ __init__.py settings.py ...

16得票11回答
Graphviz用于文档编写。

我注意到doxygen使用graphviz库来创建图表。您是否曾经使用过graphviz来生成文档?在doxygen之外的文档编制中,学习graphviz是否值得?抑或是我最好坚持使用像Visio这样的标准数据建模工具? 我知道它作为绘图库的优点,但对于尝试表示更复杂的UML(或类似)图表,仍...

16得票3回答
有没有用于生成Play 2.x API文档的插件?

我们有一个基于Play 2.x构建的相对较大的REST API,并被要求为我们内部用户编写文档。由于我们认为在单独的wiki上维护这个文档非常困难,因此我们想知道是否有任何Play文档生成工具可用?