Skip to main content

Sphinx extension to document F# libraries

Project description

sphinxcontrib-fsharp is a Sphinx (1.6.3+) extension to document F# libraries. It provides a Sphinx domain for F# and autodoc-like directives to generate documentation from source code (not ported to F# yet).

It’s licensed under the MIT license. It’s available on the Python package index. Its documentation and its source code are on GitHub.

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

Status

sphinxcontrib-fsharp is a fork of spinxcontrib-ocaml and still highly experimental. Interfaces may be changed unannounced. We welcome all contributions so please feel free to submit PRs.

Quick start

Install both packages:

$ pip3 install sphinxcontrib-fsharp

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

extensions.append("sphinxcontrib.fsharp")
primary_domain = "fsharp"  # Optional
fsharp_source_directories = ["src"]
fsharp_findlib_packages = ["batteries", "js_of_fsharp"]

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.

Source Distribution

sphinxcontrib-fsharp-0.3.1.tar.gz (7.1 kB view hashes)

Uploaded source

Built Distribution

sphinxcontrib_fsharp-0.3.1-py2.py3-none-any.whl (9.3 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page