跳转到主要内容

Sphinx扩展,用于文档化OCaml库

项目描述

sphinxcontrib-ocaml 是一个 Sphinx (1.6.3+) 扩展,用于文档化 OCaml 库。它提供了一个Sphinx ,用于OCaml和类似autodoc的指令,以从源代码生成文档。

它根据 MIT 许可证 许可。它包含两个部分,位于 Python 软件包索引 OPAM (两者都是必需的)。其 文档 和其 源代码 在GitHub上。

有问题?评论?错误?想要贡献? 提交一个问题

https://img.shields.io/travis/jacquev6/sphinxcontrib-ocaml/master.svg https://img.shields.io/github/issues/jacquev6/sphinxcontrib-ocaml.svg https://img.shields.io/github/forks/jacquev6/sphinxcontrib-ocaml.svg https://img.shields.io/github/stars/jacquev6/sphinxcontrib-ocaml.svg

状态

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

项目详情


下载文件

下载适用于您的平台文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

sphinxcontrib-ocaml-0.3.0.tar.gz (7.0 kB 查看哈希值)

上传时间

由以下支持