Mix.Tasks.Docs.Epub
Uses ExDoc to generate an EPUB file from the docstrings extracted from all of the project’s modules.
Command line options
--output
,-o
- output directory for the generated docs; default:"doc"
Configuration
The task uses the project’s :name
key if defined, otherwise it will use the
:app
key as a substitute.
It also uses the :version
key and :source_url
from the project’s configuration.
The following options should be put under the :docs
key in your project’s
main configuration. The docs options should be a keyword list or a function
returning a keyword list that will be lazily executed.
:output
- output directory for the generated docs; default: “doc”. May be overriden by command line argument.:readme
- string denoting the source file for a project README (e.g., “README.md”); default:nil
(no README created).:formatter
- doc formatter to use; default: “html”.:source_root
- path to the source code root directory; default: “.” (current directory).:source_beam
- path to the beam directory; default: mix’s compile path.:source_url_pattern
- public URL of the project. Derived from project’s:source_url
if not present.:source_ref
- the branch/commit/tag used for source link inference. Ignored if:source_url_pattern
is provided; default: master.:main
- main page of the documentation. It may be a module or a generated page, like “overview” or “readme”; default: “overview” when —fomatter is “html”.