{ "info": { "author": "Vincent Jacques", "author_email": "vincent@vincent-jacques.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 2 - Pre-Alpha", "Intended Audience :: Developers", "License :: OSI Approved", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: OCaml", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Documentation :: Sphinx" ], "description": "*sphinxcontrib-ocaml* is a `Sphinx `_ (1.6.3+) extension to document `OCaml `_ libraries.\nIt provides a Sphinx `domain `_ for OCaml and\n`autodoc `_-like directives to generate documentation from source code.\n\nIt's licensed under the `MIT license `_.\nIt's available in two parts, on the `Python package index `_\nand `OPAM `_ (both are required).\nIts `documentation `_\nand its `source code `_ are on GitHub.\n\nQuestions? Remarks? Bugs? Want to contribute? `Open an issue `__!\n\n.. image:: https://img.shields.io/travis/jacquev6/sphinxcontrib-ocaml/master.svg\n :target: https://travis-ci.org/jacquev6/sphinxcontrib-ocaml\n\n.. image:: https://img.shields.io/github/issues/jacquev6/sphinxcontrib-ocaml.svg\n :target: https://github.com/jacquev6/sphinxcontrib-ocaml/issues\n\n.. image:: https://img.shields.io/github/forks/jacquev6/sphinxcontrib-ocaml.svg\n :target: https://github.com/jacquev6/sphinxcontrib-ocaml/network\n\n.. image:: https://img.shields.io/github/stars/jacquev6/sphinxcontrib-ocaml.svg\n :target: https://github.com/jacquev6/sphinxcontrib-ocaml/stargazers\n\nStatus\n======\n\nsphinxcontrib-ocaml is still highly experimental.\nInterfaces may be changed unannounced.\nWe welcome all feedback from our daring early users.\n\nQuick start\n===========\n\nInstall both packages::\n\n $ pip3 install sphinxcontrib-ocaml\n $ opam install sphinxcontrib-ocaml\n\nEnable and configure the Sphinx extension in your ``conf.py`` file::\n\n extensions.append(\"ocaml\")\n primary_domain = \"ocaml\" # Optional\n ocaml_source_directories = [\"src\"]\n ocaml_findlib_packages = [\"batteries\", \"js_of_ocaml\"]\n\nAnd document your module (in an ``.rst`` file)::\n\n .. autoocamlmodule:: MyModule", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://jacquev6.github.io/sphinxcontrib-ocaml/", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-ocaml", "package_url": "https://pypi.org/project/sphinxcontrib-ocaml/", "platform": "", "project_url": "https://pypi.org/project/sphinxcontrib-ocaml/", "project_urls": { "Homepage": "http://jacquev6.github.io/sphinxcontrib-ocaml/" }, "release_url": "https://pypi.org/project/sphinxcontrib-ocaml/0.3.0/", "requires_dist": null, "requires_python": "", "summary": "Sphinx extension to document OCaml libraries", "version": "0.3.0" }, "last_serial": 3167472, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "d56064de32c868c1adca5456557dbf0d", "sha256": "c36bbce21dac4ea0afa12e93ea27e1062fbd0762481b9cf533378833f5268b6b" }, "downloads": -1, "filename": "sphinxcontrib-ocaml-0.1.1.tar.gz", "has_sig": false, "md5_digest": "d56064de32c868c1adca5456557dbf0d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6924, "upload_time": "2017-08-30T16:06:43", "url": "https://files.pythonhosted.org/packages/14/f0/6baad29926f6d90323a25d769825c8a057d9ddd66ebfe12ce6801511e964/sphinxcontrib-ocaml-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "afdd959deb3826989f1048d668a832b8", "sha256": "e8074486de2697ec7c2b09fc9f3d192662589d007b95b2472bb94abb48945db3" }, "downloads": -1, "filename": "sphinxcontrib-ocaml-0.1.2.tar.gz", "has_sig": false, "md5_digest": "afdd959deb3826989f1048d668a832b8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6873, "upload_time": "2017-08-30T16:19:39", "url": "https://files.pythonhosted.org/packages/30/8f/22ce8fd299aef840805320b44a336c4da3a3a92e25b0568b1d6e9ec329af/sphinxcontrib-ocaml-0.1.2.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "55e11ebbf18ff4a4ef15ea285107c22e", "sha256": "7cd1c32e73c0d2850125b3a94c0c674abf9fa737233342e259f6a462e3c72d4c" }, "downloads": -1, "filename": "sphinxcontrib-ocaml-0.2.0.tar.gz", "has_sig": false, "md5_digest": "55e11ebbf18ff4a4ef15ea285107c22e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6878, "upload_time": "2017-08-30T17:20:29", "url": "https://files.pythonhosted.org/packages/c8/c7/71a3609b46d84db22ffd9d56503c30a7762b2504a834359236d788ef8200/sphinxcontrib-ocaml-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "3fc47156ffff0da457f8add8c97ea51b", "sha256": "3b7d50dd6639118065de5dfb806ee66bfa9f08d5310c346b0988fe2249370dc2" }, "downloads": -1, "filename": "sphinxcontrib-ocaml-0.3.0.tar.gz", "has_sig": false, "md5_digest": "3fc47156ffff0da457f8add8c97ea51b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6987, "upload_time": "2017-09-12T09:09:45", "url": "https://files.pythonhosted.org/packages/14/e7/b50aef92b56d52744fca00aac6e2c4c1bee9678b71fecfc154d3dda81265/sphinxcontrib-ocaml-0.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3fc47156ffff0da457f8add8c97ea51b", "sha256": "3b7d50dd6639118065de5dfb806ee66bfa9f08d5310c346b0988fe2249370dc2" }, "downloads": -1, "filename": "sphinxcontrib-ocaml-0.3.0.tar.gz", "has_sig": false, "md5_digest": "3fc47156ffff0da457f8add8c97ea51b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6987, "upload_time": "2017-09-12T09:09:45", "url": "https://files.pythonhosted.org/packages/14/e7/b50aef92b56d52744fca00aac6e2c4c1bee9678b71fecfc154d3dda81265/sphinxcontrib-ocaml-0.3.0.tar.gz" } ] }