package odig
Lookup documentation of installed OCaml packages
Install
Dune Dependency
Authors
Maintainers
Sources
odig-0.0.4.tbz
sha256=317bff8108f310ba14b435162f27921fb21f4f8a522121b1388b26b1515c496d
md5=cea6608b4d0a62df5c358d771fd1a148
doc/CHANGES.html
v0.0.4 2019-03-08 La Forclaz (VS)
- Support for odoc manuals (
.mld
files) and package page customization (index.mld
file) (#31, #18). See the packaging conventions; if you are usingdune
and already authoring.mld
files the right thing should be done automatically install-wise. - Support for odoc themes (#21). Themes can be distributed via
opam
, see commandodig odoc-theme
and the packaging conventions inodig doc odig
. - Support for best-effort OCaml manual theming. Themes can provide a stylesheet to style the local manual installed by the
ocaml-manual
package and linked from the generated documentation sets. - Support for customizing the title and introduction of the package list page (#19). See the
--index-title
and--index-intro
options ofodig odoc
. - Add
gh-pages-amend
a tool to easily push documentation sets on GitHub pages (see the odig manual and--help
for details). - The
opam
metadata support needs anopam
v2 binary in yourPATH
. - The odoc API documentation generation support needs an
odoc
v1.4.0 binary in yourPATH
. odig doc
exit with non-zero on unknown package (#34).odig doc
add-u
option to guarantee docset freshness (#4).- Depend only on
cmdliner
andb0
. Drop dependency oncompiler-libs
,rresult
,asetmap
,fpath
,logs
,mtime
,bos
,webbrowser
andopam-format
.
Removals
- The best-effort
ocamldoc
support and corresponding command are dropped. - The
metagen
andlinkable
experimental tools are gone. - The data-driven toplevel loaders are gone. See the
omod
project if your are interested in this. - Removed JSON output from the commands that supported it.
- The
help
command is dropped. Documentation is now inodig
's API docs and is where the manual and the packaging conventions can be found. Consultodig doc odig
. - The
--docdir-href
option ofodig odoc
no longer exists. The docset in$(odig cache path)/html
is self-contained and can be published as is (provided you follow symlinks). - The
authors
,deps
,maintainers
,tags
,version
andrepo
commands are gone but the lookups are available via theshow
command. - The
homepage
,issues
andonline-doc
commands are available via theshow
andbrowse
commands. - The
cobjs
,graph
andguess-deps
commands are dropped.
v0.0.3 2017-10-31 Zagreb
- Fix obscure build bug on 4.06.0 (#32)
v0.0.2 2017-05-31 Cambridge (UK)
- Added experimental data-driven toplevel loaders.
- The
odoc
API documentation is shown by default onodig doc
. - The
mli
,cmi
,cmo
,cmti
,cmx
andcmt
commands are grouped in thecobjs
command. - Track latest cmdliner and mtime.
v0.0.1 2016-09-23 Zagreb
First release. The ocamldoc release.
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>
On This Page