Skip to content

Releases

ldoc 0.1.0

Choose a tag to compare

@oubiwann oubiwann released this 14 Nov 18:32

ldoc 0.1.0 is the first release of a new native documentation pipeline for Erlang
and LFE: it collects trusted BEAM documentation, retains a readable native snapshot,
and builds a versioned static reference. In particular:

  • The collector reads embedded EEP-48 Docs, associated package sidecars and
    classic LFE documentation artifacts. Carrier precedence is explicit; malformed data
    produces an error rather than selecting another source.
  • ldoc build compiles a trusted flat application, checks its source/app/BEAM
    inventory and creates a fresh reference. Erlang comment documentation can be
    converted through EDoc using the matching build's includes, macros and
    dependency headers.
  • Snapshots retain producer documentation, annotations, signatures, metadata
    and supported structured terms. Exact release keys are immutable (identical
    retries succeed, while conflicting data is rejected).
  • The reference provides an exact-version catalogue, module and definition
    navigation, filtering and responsive layouts (based upon cljdoc's layout).
    Public module and function contracts are documented in the source and
    generated reference. Source links use explicit declared provenance and do
    not authenticate a repository revision.
  • Source installation uses a published GitHub tag and cleans its temporary
    build workspace. make docs leaves a browsable reference; make publish
    generates fresh ldoc documentation and publishes source and docs together.

The supported build matrix is OTP 27–29 with Rebar3 3.28.0. The library uses
LFE 2.2+ and the inherited rebar3_lfe 0.5.8 compiler plugin; maintainers use
rebar3_hex 7.5.0. A full OTP installation supplies the compiler, crypto and EDoc
chunk tooling. Distribution is source-built through the central README guide.

The command supports flat default-profile applications and trusted local
inputs. BEAM inspection does not load target code into the tool VM; ordinary
project scripts and compile-time code can run in the child build.

ldoc is licensed under Apache-2.0.