anvl_texinfo ¶A plugin for creating and compiling GNU TexInfo files.
-type doc_format() :: info |
docbook |
html |
epub3 |
latex |
plaintext.
-spec erl_module_doc(OutputDir :: file:filename(),
AppInfo :: anvl_erlc:app_info(),
Mod :: module()) -> anvl_condition:t().
Render documentation for an Erlang module.
-spec erl_doc(Profile :: anvl_erlc:profile(),
App :: anvl_erlc:application()) -> anvl_condition:t().
Render documentation for an Erlang application App compiled in profile Profile.
-spec compiled(anvl_project:t(), file:filename(),
doc_format()) -> anvl_condition:t().
Condition: a source file DocSrc in project Project is compiled to format Format.
-spec compiled(anvl_project:t()) -> anvl_condition:t().
Condition: all texinfo sources listend in the project configuration are compiled to all formats requested by the project.
-spec available() -> boolean().
Check if the system has texi2any executable necessary for building TexInfo.
Condition: documentation for the Plugin has been extracted.
This condition is specific for ANVL plugins.