Skip to main content

Sphinx extension to document OCaml libraries

Project description

sphinxcontrib-ocaml is a Sphinx (1.6.3+) extension to document OCaml libraries. It provides a Sphinx domain for OCaml and autodoc-like directives to generate documentation from source code.

It’s licensed under the MIT license. It’s available in two parts, on the Python package index and OPAM (both are required). Its documentation and its source code are on GitHub.

Questions? Remarks? Bugs? Want to contribute? Open an issue!

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

Status

sphinxcontrib-ocaml is still highly experimental. Interfaces may be changed unannounced. We welcome all feedback from our daring early users.

Quick start

Install both packages:

$ pip3 install sphinxcontrib-ocaml
$ opam install sphinxcontrib-ocaml

Enable and configure the Sphinx extension in your conf.py file:

extensions.append("ocaml")
primary_domain = "ocaml"  # Optional
ocaml_source_directories = ["src"]
ocaml_findlib_packages = ["batteries", "js_of_ocaml"]

And document your module (in an .rst file):

.. autoocamlmodule:: MyModule

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-ocaml, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-ocaml-0.3.0.tar.gz (7.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page