odoc icon indicating copy to clipboard operation
odoc copied to clipboard

Provide a Complete Module Index

Open sabine opened this issue 2 years ago • 3 comments

One recurring feature request we get for OCaml.org is the wish to have a full index (which we would use on to the left navigation on the ocaml.org package documentation) that includes all the definitions within the modules / classes / etc.

I think it's a valid request that also enables a diff of the module index between package versions.

sabine avatar Oct 17 '23 07:10 sabine

We have plans to improve the navigation side bar in the future (though not concrete enough yet) that would include listing submodules and siblings modules. It would hopefully be good enough for ocaml.org. Do you also plan to generate a page listing all the definitions ?

@panglesd Do you think the work on occurrence counting could help list the definitions ?

Julow avatar Jan 22 '24 15:01 Julow

We have plans to improve the navigation side bar in the future (though not concrete enough yet) that would include listing submodules and siblings modules. It would hopefully be good enough for ocaml.org. Do you also plan to generate a page listing all the definitions ?

Just putting this here so it's not forgotten. No concrete plans to do this right now.

A thing we can do with a complete index is to compute diffs between two package versions to know when a given value has been added or removed between versions.

sabine avatar Jan 22 '24 16:01 sabine

@panglesd Do you think the work on occurrence counting could help list the definitions ?

The occurrence command list the occurrences as found in the implementation files. If no occurrence is found, the table won't include the definition.

Maybe the index for search entries could be used instead...

panglesd avatar Jan 24 '24 12:01 panglesd