Folders starting with underscore on github pages

[hbr]

I have run into the following problem. I have an ocaml project where I generate the documentation with odoc. odoc generates the directory _odoc_support where files like odoc.css etc. are put.

Unfortunately github pages with jekyll considers directories starting with underscore as special and does not copy them to the final site. In that case the rendering of the documentation does not look nice.

I have found a workaround by putting an empty file called .nojekyll at the root of my github pages. But in the long run it would be better if odoc did not generate directories starting with underscore.

Regards
Helmut

[dbuenzli]

But in the long run it would be better if odoc did not generate directories starting with underscore.

We need a name that cannot be accessed via the module or .mld namespace. The current name satisfies this property. I'm not sure there's really better alternative here.

Given that other people with other systems seem to struggle with this I'd rather say the problem is with jekyll here.

[jonludlam]

odoc itself supports putting the support files wherever you like - it's up to the driver to tell odoc to do that though. I'm guessing you're using dune to create the docs? In which case, dune could be updated to be able to specify the location of the support directory.

[jonludlam]

So you'd need to make this configurable: https://github.com/ocaml/dune/blob/e4ee4004e911eb022e585a9a3034fe1ce13a7569/src/dune_rules/odoc.ml#L88

[hbr]

odoc itself supports putting the support files wherever you like - it's up to the driver to tell odoc to do that though. I'm guessing you're using dune to create the docs? In which case, dune could be updated to be able to specify the location of the support directory.

I am using dune 3.7.1 which is the most recent version. How can I tell dune the location of the support directory?

[jonludlam]

You can't, it's hardcoded right now - see my link above. Dune would need modification in order to do this, so your issue is with dune, not odoc :-) I'll close this, but feel free to make an issue for dune.

[dbuenzli]

For xref there is one here ocaml/dune#7364