odoc

odoc copied to clipboard

Overhaul of module-type-of and shadowing

1

This PR contains a relatively big overhaul of how we do module-type-of expansions in particular, but also how we reuse previously calculated expansions for other module type expressions too. In...

jonludlam

Add a marshalled output for index generation

11

This PR adds a new marshalled output for the generation of index files. This is desirable for several reasons: - It allows to combine several pre-built indexes, making the index...

panglesd

While changing the positioning of the deprecated attribute according to https://github.com/ocaml/ocaml/issues/13054, the HTML output changed, removing the 'Top Comment' that was being output into Alert.html. There are some changes to...

jonludlam

When writing manuals in `.mld` files, the `{!modules:...}` directive is very useful and I think it would be really handy to support more listing directives, to encourage writing manuals in...

xvw

Adding a font-awesome icon for external links

5

This is a PR to address Issue #669. It adds an icon after external links. The icon is taken from here: https://fontawesome.com/v6.0/icons/up-right-from-square (it's the only "external link" icon that is...

panglesd

Doc sherlodoc

2

This is two things rebases https://github.com/ocaml/odoc/pull/1064, and update the sherlodoc interface to the definitive one released in sherlodoc. This gives the benefits that stdlib results are not shown above odoc...

EmileTrotignon

Assertion failed on mutual recursion with optional arguments

6

Minimal example and triggered assertion: ```ocaml type t = int option let rec f ?(optional : t) () = f ?optional () and g () = f ?optional:(Some 1) ()...

Bastacyclop

Add occurrence count in the json output for search engine

1

Since #972 there is a `compile-index` command which outputs a json index containing all searchable entries. The intended purpose of this json index is to pass it to a search...

panglesd

Failed to resolve module path identifier

4

Hi, When applying [this change to Owi](https://github.com/zapashcanon/owi/blob/f172783ab86c0699af7ec50d422bef36d9bd2bff/src/symbolic_value.mli#L7-L24), I got the following: ```shell-session $ dune b @doc File "../../src/.owi.objs/byte/owi.odoc": Warning: Failed to resolve module path identifier((root Owi__Symbolic_value).{Bool}1, true) Lookup failure (module):...

zapashcanon

Error reporting / warnings are inconsistent and don't make sense

2

See e.g. https://github.com/ocaml/odoc/pull/784 for some confusion caused.

jonludlam