Skip to content

toroidal-code/yoda

Repository files navigation

YODA - Yet another OCaml Documentation Authoring tool

“Always pass on what you have learned.” - Yoda

YODA is an ocamldoc replacement(-ish) designed with more in mind than simple documentation. It's intended to be a full-featured processor for literate programming, although it will be more than suited to handling normal documentation tasks. The tool is driven by Pandoc and requires it to be installed (version 1.14+) along with libpandoc

Feature wishlist:

  • Markdown Support
  • Embedded LaTeX Support w/ MathJax
  • Site generation like oredoc
  • YARD-style function annotation syntax
  • Typing done by merlin

About

Yet another OCaml Documentation Authoring tool

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published