ocaml / ocaml/dune

doc: install html documentation

Open
#3,495 4 comments 0 reactions 1 assignee View on GitHub

@jonludlam is already working on this.

Since May 20, 2020.

build odoc
Dominant language
OCaml
Stars
1.9k
Forks
500
Avg merge
15h 21m
Merged PRs (30d)
277

Description

Desired Behavior

I'd like to have at least the option or a simple way to add the generated html docs
to the install target, so they'd maybe be installed to prefix/doc/<package>/html or
similar.

Also this could possibly be used to solve the issue of documentation of dependencies
(#3436, #1949) in the future, although it also would have some problems: You could discover the
path of the installed documentation of dependencies and link the relevant
types/functions/modules to there. This would be similar to how it is possible with
haddock of the Haskell infrastructure.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.