Skip to content
Sphinx extension to document F# libraries
Branch: master
Clone or download
Pull request Compare This branch is 6 commits ahead, 1 commit behind jacquev6:master.
Latest commit 6da0afe May 12, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Moved docs May 12, 2019
ocaml_autodoc migrate build from jbuilder to dune Jul 29, 2018
sphinxcontrib Moved docs May 12, 2019
test Upgrade Sphinx version used Jan 8, 2018
.gitignore Initial work of refactoring to F# Apr 19, 2019
LICENCE.txt Fix home page Aug 30, 2017
README.rst Fixes for doc and setup. F# not a valid classifier. Apr 19, 2019
run_development_cycle.sh Migrate to opam 2 Nov 5, 2018
setup.py Bump version and fix url Apr 20, 2019

README.rst

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
You can’t perform that action at this time.