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!
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
1 maintainer
Metadata
1 maintainer
Release files for sphinxcontrib-ocaml 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinxcontrib-ocaml-0.3.0.tar.gz | 7.0 kB | Without provenance | Details for sphinxcontrib-ocaml-0.3.0.tar.gz |
Release files / sphinxcontrib-ocaml-0.3.0.tar.gz
| Download URL | sphinxcontrib-ocaml-0.3.0.tar.gz |
|---|---|
| Size | 7.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3b7d50dd6639118065de5dfb806ee66bfa9f08d5310c346b0988fe2249370dc2
|
|
BLAKE2b-256 checksum How to use checksums |
14e7b50aef92b56d52744fca00aac6e2c4c1bee9678b71fecfc154d3dda81265
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinxcontrib-ocaml 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
