ExDoc formater to build a docset for Dash/Zeal
OTHER License
Bundles :ex_doc
documentation into a docset.
Docsets can be loaded into Dash(Mac OS) or Zeal(Win/Linux). Not yet tested with Zeal though.
In mix.exs
add the formatters config:
def project do
[
app: :my_app,
version: "0.1.0-dev",
deps: deps(),
# Docs
docs: [
formatters: ["html", "epub", ExDocDocset.Formatter.DocSet]
]
]
end
The formatter will then create a docset in your ./doc
folder.
ex_doc
team on how to make enough things public for the usecase:navigator.userAgent.includes('Dash/')
If available in Hex, the package can be installed
by adding ex_doc_docset
to your list of dependencies in mix.exs
:
def deps do
[
{:ex_doc_docset, "~> 0.1.0"}
]
end
Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/ex_doc_docset.