Home

Awesome

CoqdocJS

CoqdocJS is a little script to dynamically improve the coqdoc output. The result can be seen here:

https://www.ps.uni-saarland.de/autosubst/doc/Ssr.POPLmark.html

It offers the following features:

All of this works with the ordinary coqdoc, by asking coqdoc to use a header file including the javascript files and some custom CSS.

Usage

  1. Clone this repository as a subdirectory or submodule;
  2. Include Makefile.doc in your Makefile, or copy it as, e.g., Makefile.coq.local;
  3. Run make coqdoc to build documentations.

A minimal example is shown here.

Environment Variables

NameUsageDefault
COQDOCFLAGSOverride the flags passed to coqdocsee Makefile.doc
COQDOCEXTRAFLAGSExtend the flags passed to coqdocempty
COQDOCJS_LNIf set to true then symlink resource files; otherwise copyfalse
COQDOCJS_DIRFolder containing CoqdocJScoqdocjs
COQMAKEFILEMakefile generated by coq_makefileMakefile.coq

Files