文档ocaml库的sphinx扩展
sphinxcontrib-ocaml的Python项目详细描述
sphinxcontrib ocaml是文档库OCaml的Sphinx(1.6.3+)扩展。 它为ocaml和 autodoc类似于从源代码生成文档的指令。
它是根据MIT license授权的。 它分为两部分,在Python package index 和OPAM(两者都是必需的)。 它的documentation 它的source code在github上。
有问题吗?评论?漏洞想做贡献吗?Open an issue!
状态
sphinxcontrib ocaml仍然是高度实验性的。 接口可以在未经通知的情况下更改。 我们欢迎所有大胆的早期用户的反馈。
快速启动
安装两个软件包:
$ pip3 install sphinxcontrib-ocaml $ opam install sphinxcontrib-ocaml
在conf.py文件中启用并配置sphinx扩展名:
extensions.append("ocaml") primary_domain = "ocaml" # Optional ocaml_source_directories = ["src"] ocaml_findlib_packages = ["batteries", "js_of_ocaml"]
并记录您的模块(在.rst文件中):
.. autoocamlmodule:: MyModule