Question

如何为julia创建本地版本的文档？我试过了：

/Applications/Julia-0.3.1.app/Contents/Resources/julia/share/julia/doc make html
fatal: Not a git repository (or any of the parent directories): .git
make: [juliadoc-pkg] Error 128 (ignored)
PYTHONPATH=:juliadoc sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.3b1

Extension error:
Could not import extension juliadoc.jldoctest (exception: cannot import name bytes)
make: *** [html] Error 1
/Applications/Julia-0.3.1.app/Contents/Resources/julia/share/julia/doc

虽然狮身人面像似乎有效，但看起来我错过了某些扩展？有人可以帮忙吗？谢谢！

Answer 1

Julia v0.4以后文档系统是内联的，可以使用Documenter.jl包生成。位于函数，类型，宏，模块和其他对象正上方的内联doc字符串被解释为记录所附对象。函数get_coeff()的示例如下所示，

""" 
    get_coeff(a, v)
Return the coefficient of `a::TaylorN`, specified by
`v::Array{Int,1}` which has the indices of the specific monomial.
"""
function get_coeff(a::TaylorN, v::Array{Int,1})

有关文件编制的更多详细信息，请参见here。

下一步是文档生成，使用Documenter.jl包。详细步骤解释为here，正如所解释的那样，输出可以作为markdown或html获得。如果需要pdf，我会使用pandocs将.md文件转换为pdf。

Answer 2

可能需要从Julia git存储库的克隆构建文档，而不是从Julia源的存档构建文档。通过安装和执行git很容易实现：

git clone https://github.com/JuliaLang/julia.git

以下代码片段在我的机器上重新创建了Julia文档：

cd doc # change into the doc directory of the julia repository
make latex SPHINXOPTS="-n"
make latexpdf
# view the newly created PDF using linux default PDF viewer
evince _build/latex/JuliaLanguage.pdf

（按下几个Enter键以忽略LaTeX字体问题，但是文档结果确定没问题）

Answer 3

请注意，现在Documenter.jl支持直接通过LaTeX输出pdf。参见the documentation：

Pkg.add(DocumenterLaTeX)
using DocumenterLaTeX
makedocs(
    format = LaTeX,
    ...
)

如何为julia创建脱机文档

3 个答案: