ocaml/dune

Package pre-built sphinx docs with dune release tars

開放

#5,115 建立於 2021年11月8日

 (2 則留言) (0 個反應) (0 位負責人)OCaml (478 個分叉)github user discovery
acknowledgedenhancementhelp wanted

倉庫指標

星標
 (1,882 顆星)
PR 合併指標
 (平均合併 1天 20小時) (30 天內合併 345 個 PR)

描述

The default help provided by dune is not detailed enough.

It would be great if we could type dune help and this would open a browser window showing dune documentation. These would be the same docs you get by invoking make doc in dune source (essentially what you get at https://dune.readthedocs.io ).

We can't assume that people have sphinx installed on their local machine. So I'm not advocating that we build the docs when we install dune on a switch.

I am suggesting that we package up pre-built sphinx generated documentation into the opam tbz release files.

Precedent For those who use the fish shell, if you type

$ help

It opens locally stored HTML documentation for the fish shell in your browser. (If you don't use fish, please install it momentarily to just try this out...)

Possible Issues I built sphinx documentation and looked at it locally. Everything looks good.

However, it looks like there is a regression in the search feature on localhost. I get search results but I am not able to see the matching hits and their context. I understand that readthedocs provides full text search over and above the default sphinx browser search.


  • Do you think this feature is useful?
  • If so, would the dune team be interested in implementing it?
  • If the feature is considered useful but the dune team does not have the time, I can volunteer to implement this feature but I would appreciate some general pointers on how to proceed...

貢獻者指南