标签: documentation

我过去见过的Latex-to-html转换器非常糟糕.编辑原始HTML并不好玩,似乎不能很好地转换为打印页面.别人怎么解决这个问题？示例链接(pdf和html)都很棒.

补充:刚问了另一个类似的问题:

我应该使用什么格式化语言来编写项目文档

Django的网站看起来不错,但由于某种原因我无法找到下载文档的位置:

http://docs.djangoproject.com/en/1.1/

(是的,我需要1.1的文档)

有人知道吗？

我正在寻找关于Ruby语法的权威文档.我知道核心API和标准库的权威文档,但语法本身呢？举例来说,这样的文件应包括:保留字,字符串语法,命名规则的变量/类/模块,所有的条件语句和它们的排列,等等.

我知道有很多书和教程,是的,但是每一本都是教程,每一本都有不同的深度和焦点.他们都必须通过简洁和叙事流程,省略作者认为无关紧要的语言的某些细节.

例如,您是否知道可以使用没有初始案例值的case语句,然后它将执行第一个true when子句？任何给定的Ruby书籍或教程可能会也可能不会涵盖案例语法的特定鲜为人知的功能.关于案例陈述,"Ruby Ruby"一节中没有对此进行讨论.但这只是一个小例子.

到目前为止,我发现的最好的文档是rubyspec项目,它似乎是尝试为该语言编写完整的测试套件.这还不错,但从实际的角度来看,作为开发我自己项目的开发人员有点困难.

我只是遗漏了一些东西,或者是否真的没有明确可读的文档来定义整个Ruby语法？

除了这里出色的SO答案,还有Roxygen 手册和插图,是否有任何特别全面的使用Roxygen指南？

我想开始使用Sphinx记录我的项目.我告诉Sphinx在使用过程中使用单独的源代码和构建目录sphinx-quickstart.现在我的目录布局如下:

MyProject/
    myproject/
        __init__.py
        mymodule.py
    docs/
        source/
            .static/
            .templates/
            conf.py
            index.rst
        build/
        Makefile

应该从Sphinx项目的VCS存储库中排除哪些文件(即,因为我使用Git,我应该将什么添加到我的.gitignore文件中)？例如,我是否应该忽略该docs/build/目录,以便不跟踪从Sphinx生成的HTML页面中的更改？

是否有任何方法AppCode 3.0可以生成文档注释IntelliJ？

例如,IntelliJ我可以输入一个方法:

public int method(float number){
    // magic
}

当它高于它时,我将输入:/**,IDE将生成如下代码:

/**
*
* @param number
* @return
*/
public int method(float number){
    // magic 
}

在AppCode 3.0做了类似的技巧后,我只得到这样的东西:

/**
*
*/
- (int)method:(float)number;

我已经检查过Preferences/Smart Keys/Insert documentation comment stub并且已经过检查.

在Node.js v0.12发布之后,官方文档现在不再允许我们浏览节点v0.10文档.

是否有v0.10的在线node.js文档(不是最新版本)？

谢谢

我想为计算机视觉领域的项目,模块和库集合准备一份文档(主要用c ++编写).为此,我查看了OpenCV文档,您可能知道OpenCV 2.4.x文档基于Sphinx,这是我寻求的确切解决方案.Sphinx的优点是:

1. 从语义角度看模块的层次结构.例如,卡尔曼滤波器是运动分析和对象跟踪模块的子代
2. 您可以添加图像和数学公式
3. 相当不错的嵌入式搜索引擎

但我意识到OpenCV3.0的c ++版本是基于Doxygen记录的,我不知道为什么!因为它没有Sphinx那么有趣.我知道Doxygen可以编译你的代码并提取你的评论,这是一个有用的功能.我也知道有些库(如呼吸)可以作为Doxygen和Sphinx之间的桥梁.

现在我的问题是:

1. 彼此的Sphinx和Doxygen替代品还是可以和它们一起使用？
2. Doxygen是否具有Sphinx所提到的功能？
3. 您更喜欢哪个文档引擎(Sphinx,Doxygen或其他引擎)？

如何在Kotlin的默认文档工具KDoc中插入代码片段？

在Java中,我可以使用以下内容:

/**
 * Example usage:
 *
 * <pre>
 * <code>&#64;JavaAnnotation
 * public void foo() {
 *     // Code
 * }
 * </code>
 * </pre>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface JavaAnnotation {}

Kotlin似乎没有相应的东西.我尝试使用Markdown,但在行结束后插入2个空格不会换行.

我正在使用roxygen2作为记录我的R包的工具,我发现roxygen2中有一个@references标签,但这似乎只接受自由格式文本.我找到了一些关于roxygen的演示文稿,其中有@bibliograph和@cite标签,但我是否认为roxygen2中没有这样的东西？

我应该以某种方式从bibtex文件中取出引用并在@references标记之后直接用适当的格式手动编写它们,还是有更聪明的方法呢？在多个函数/ rd文件中,我需要引用大约七篇不同的文章.