Skip to Content.
Sympa Menu

coq-club - Re: [Coq-Club] Documentation for libraries installed through opam.

coq-club AT inria.fr

Subject: The Coq mailing list

List archive

Re: [Coq-Club] Documentation for libraries installed through opam.


Chronological Thread 
  • From: Christian Doczkal <christian.doczkal AT inria.fr>
  • To: coq-club AT inria.fr
  • Subject: Re: [Coq-Club] Documentation for libraries installed through opam.
  • Date: Thu, 26 Mar 2020 10:11:35 +0100

Hi,

I'm afraid there is no established standard way, at least none that I
know of. (I'd be happy to be corrected on this.)

Many packages have GitHub repositories and HTML documentation on the
respective project websites. So getting the websites with wget or
checking out the repository and running the make html (or any custom
documentation targets) may be options.

It seems that not many people are using "local" documentation these
days, so the UNIX tradition of installing docs to
/usr/share/doc/<package> is dying.

Best,
Christian




On 3/24/20 9:33 PM, Izzy wrote:
> Dear Coq-club,
>
> Is there a recommended or standard way of getting local web-browser
> friendly documentation for libraries installed using opam?
>
> My current method of :
>
> $find "$(pwd)" | grep -i '\.v$' >> /tmp/libraryfiles
>
> $coqdoc --files-from /tmp/libraryfiles.txt --html --toc
>
> works but I'm hoping there is something more like odig or racodocs for
> ease browsing, searching, and automated generation.
>
> Izzy
>



Archive powered by MHonArc 2.6.18.

Top of Page