package odig
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=1398656a8719a37db3f47083a08ab7124ec51bd1df5fe0e4b65410088267f21eccb096ea7494237c411a68e17c44c27d3789f1c8835dcb533c921391425f4def
CHANGES.md.html
v0.0.7 2021-10-09 Zagreb
Stylesheet support for odoc 2.0.0.
--index-intro
option. Fix option no longer interpreting relative files w.r.t. the cwd.Add
--index-toc
option, to specify the package index table of content. If you used to define a table of contents in the--index-intro
fragment you now need to define it via this option. The contents goes into theodoc-toc
nav
element.
v0.0.6 2021-02-11 La Forclaz (VS)
Stylesheets. Change strategy to make code spans unbreakable. The previous way broke Chrome in-page search.
Track
b0
changes.Update link to OCaml manual (#59).
Require OCaml >= 4.08.0
v0.0.5 2020-03-11 La Forclaz (VS)
Rework the
odoc-theme
command. Theset
command now unconditionally writes to~/.conf/odig/odoc-theme
and sets the theme for generated doc (the--default
flag no longer exists). Thedefault
command is renamed toget
, a--config
option is added to get the theme actually written in the configuration file.Add theme
odig.default
,gruvbox
andsolarized
. These themes automatically switch between their corresponding light or dark version acccording to the user browser preference (#54).Make
odig.default
the default theme instead ofodoc.default
.Generate package index page even if some package fails (#57).
Hide anchoring links to screen readers on odig generated pages (#55).
Remove the
--trace
option ofodig odoc
and correspondingODIG_ODOC_TRACE
variable for generating a build log in Event trace format. See theodig log
command. Useodig log --trace-event
to generate what--trace
did.For consistency with other tools, options
--{cache,doc,lib,share}dir
are renamed to--{cache,doc,lib,share}-dir
and corresponding environment variable fromODIG_{CACHE,DOC,LIB,SHARE}DIR
toODIG_{CACHE,DOC,LIB,SHARE}_DIR
.mld only packages: work around
odoc html-deps
bug (#50).Package landing pages: fix cache invalidation. In particular opam metadata changes did not retrigger a rebuild.
gh-pages-amend
tool, add a--cname-file
option to set theCNAME
file in gh-pages.Fix
META
file (#52). Thanks to Kye W. Shi for the report.Fix 4.08
Pervasives
deprecation.Require OCaml >= 4.05.0
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.