odoc: put odoc support files in odoc.support #7588
Conversation
emillon
added
the
odoc
|
Should we also check that gh-pages works with this name? |
|
It's a good point, it seems to be ignored too... https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#configuring-jekyll-in-your-github-pages-site |
|
I guess we should bite the bullet and just call it |
|
Adding a |
When would that be the case? If I understand correctly, the issue is that if you deploy the contents of the docs folder to the root of the gh-pages branch. In that case, you're deploying a static website, there can't be any jekyll in there. Are you thinking of the case where the doc folder is a subdirectory of a gh-pages website? In that case I don't think that |
|
I'm currently working on a project that would put all the docs currently in |
Of course! I think upstream |
Fixes ocaml#7364 If the directory is named `_odoc_support` with a leading underscore, it is omitted when deploying to github pages. This is because this system also support the jekyll site generator, which uses this convention for data files. We can not use any directory name here since we want to avoid conflicts with OCaml identifiers and names of `*.mld` files. Signed-off-by: Etienne Millon <[email protected]>
emillon
changed the title
CHANGES: - Correctly set `MANPATH` in `dune exec`. Previously, we would use the `bin/` directory of the context. (ocaml/dune#7655, @rgrinberg) - Allow overriding the `ocaml` binary with findlib configuration (ocaml/dune#7648, @rgrinberg) - Modules that were declared in `(modules_without_implementation)`, `(private_modules)` or `(virtual_modules)` but not declared in `(modules)` will cause Dune to emit a warning which will become an error in 3.9. (ocaml/dune#7608, fixes ocaml/dune#7026, @Alizter) - Dune can now detect Coq theories from outside the workspace. This allows for composition with installed theories (not necessarily installed with Dune). (ocaml/dune#7047, @Alizter, @ejgallego) - Fix regression where Merlin was unable to handle filenames with uppercase letters under Windows. (ocaml/dune#7577, @nojb) - On nix+macos, pass `-f` to the codesign hook to avoid errors when the binary is already signed (ocaml/dune#7183, fixes ocaml/dune#6265, @greedy) - Fix bug where RPC clients built with dune-rpc-lwt would crash when closing their connection to the server (ocaml/dune#7581, @gridbugs) - Introduce mdx stanza 0.4 requiring mdx >= 2.3.0 which updates the default list of files to include `*.mld` files (ocaml/dune#7582, @Leonidas-from-XIV) - Fix RPC server on Windows (used for OCaml-LSP). (ocaml/dune#7666, @nojb) - In `(executable)`, `(public_name -)` is now equivalent to no `(public_name)`. This is consistent with how `(executables)` handles this field. (ocaml/dune#7576 , fixes ocaml/dune#5852, @emillon) - Change directory of odoc assets to `odoc.support` (was `_odoc_support`) so that it works with Github Pages out of the box. (ocaml/dune#7588, fixes ocaml/dune#7364, @emillon)
Fixes #7364
If the directory is named
_odoc_supportwith a leading underscore, it is omitted when deploying to github pages. This is because this system also support the jekyll site generator, which uses this convention for data files.We can not use any directory name here since we want to avoid conflicts with OCaml identifiers and names of
*.mldfiles. Starting with a dot seems to fit the requirements.