Skip to content

odoc master + jbuilder doc generation results in blank index pages #791

@avsm

Description

@avsm

For some libraries, using jbuilder+odoc master results in an error and a blank index page (and hence no docs being generated). For example:

$ opam source yaml --dev
$ cd yaml
$ jbuilder build @doc
        odoc _doc/_odoc/pkg/yaml/page-index.odoc
File "../../../_mlds/yaml/index.mld", line 3, characters 0-25:
only one title-level heading is allowed
        odoc _doc/_html/yaml/Yaml__Types/.jbuilder-keep,_doc/_html/yaml/Yaml__Types/index.html
odoc should not generate html but will for the time being...
        odoc _doc/_html/yaml/Yaml__/.jbuilder-keep,_doc/_html/yaml/Yaml__/index.html
odoc should not generate html but will for the time being...
        odoc _doc/_html/yaml/Yaml__Stream/.jbuilder-keep,_doc/_html/yaml/Yaml__Stream/index.html
odoc should not generate html but will for the time being...
        odoc _doc/_html/yaml/Yaml_ffi__G/.jbuilder-keep,_doc/_html/yaml/Yaml_ffi__G/index.html
odoc should not generate html but will for the time being...
        odoc _doc/_html/yaml/Yaml_ffi__M/.jbuilder-keep,_doc/_html/yaml/Yaml_ffi__M/index.html
odoc should not generate html but will for the time being...
        odoc _doc/_html/yaml/Yaml_types__G/.jbuilder-keep,_doc/_html/yaml/Yaml_types__G/index.html
odoc should not generate html but will for the time being...
        odoc _doc/_html/yaml/Yaml_types__M/.jbuilder-keep,_doc/_html/yaml/Yaml_types__M/index.html
odoc should not generate html but will for the time being...

While the docs are generated, there is a blank index file due to the warning from the mld. The contents of the relevant mld file referenced is:

$ cat _build/default/_doc/_mlds/yaml/index.mld 
{1 Library yaml}
The entry point of this library is the module:
{!module-Yaml}.
{1 Library yaml.bindings}
The entry point of this library is the module:
{!module-Yaml_bindings}.
{1 Library yaml.bindings.types}
The entry point of this library is the module:
{!module-Yaml_bindings_types}.
{1 Library yaml.c}
The entry point of this library is the module:
{!module-Yaml_c}.
{1 Library yaml.ffi}
The entry point of this library is the module:
{!module-Yaml_ffi}.
{1 Library yaml.types}
The entry point of this library is the module:
{!module-Yaml_types}.
{1 Library yaml.unix}
The entry point of this library is the module:
{!module-Yaml_unix}.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions