ppxlib icon indicating copy to clipboard operation
ppxlib copied to clipboard

Broken documentation links and empty pages?

Open alan-j-hu opened this issue 5 years ago • 3 comments

The home page (https://ppxlib.readthedocs.io/en/latest/) links to Index (https://ppxlib.readthedocs.io/en/latest/genindex.html), which has no content, and Module Index (https://ppxlib.readthedocs.io/en/latest/py-modindex.html), which does not exist. I cannot find API documentation on that site. Is this a mistake?

alan-j-hu avatar Apr 18 '19 21:04 alan-j-hu

Not sure what's going on with readthedocs, the style looks odd as well.

You can find the API documentation there: https://ocaml-ppx.github.io/ppxlib/

ghost avatar Apr 23 '19 06:04 ghost

Thanks! Also, what's up with the Ppxlib__.Import. prefixes everywhere for built-in types, e.g.

val elist : (Ppxlib__.Import.expression Ppxlib__.Import.list -> Ppxlib__.Import.expression) with_loc

instead of

val elist : Parsetree.expression list -> Parsetree.expression

?

This makes the documentation very annoying to read/parse visually, and it would be nice to have the types match the "default" names.

kwshi avatar Jul 30 '19 20:07 kwshi

That is a limitation with the documentation generator (odoc) that we hope will be lifted soon (in a couple of weeks / months).

trefis avatar Jul 31 '19 07:07 trefis