You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently (generate_opam_files true) will effectively unconditionally generate opam files, which include "odoc" {with-doc} under depends and "@doc" {with-doc} in build. There are packages, which often include no documentation: executable-only packages (#1496) or ppx packages (technically contain libraries, but not intended for usage as normal library). In such cases there are currently the following possibilities:
Have a practically unused odoc dependency.
Manually remove those parts from the generated opam files, which is annoying.
Manually write some .mld documentation for the executable/ppx such that the documentation wouldn't be completely pointless.
Such practically unused documentations are especially visible in https://v3.ocaml.org/packages, even when the package itself intentionally doesn't publish documentation on GitHub Pages of its own repository or whereever. Manually written filler documentation (3. from above) is even less useful on the new site because the README is already shown, which for executables and ppxs likely already contains useful information. There wouldn't be any point maintaining an analogous .mld document.
Therefore, it would be useful to have a way to disable documentation dependency and generation for automatically produced opam files. Or possibly even have the option apply more generally to even the availability of the @doc alias, not just for opam file generation.
Depending on the scope of the option, it could be a top-level stanza like (documentation ...) in dune-project or just an argument of (generate_opam_files ...) instead of just true.
The text was updated successfully, but these errors were encountered:
It is reasonnable, my two cents for the placement. If it is outside generate_opam_files, it should also disable the @docalias. So I would prefer inside generate_opam_files. If at some point we add the external one we always can make it change the default of generate_opam_files. We can have something like (generate_opam_files (doc <true|false>) (tests <true|false>)). (or ẁith_doc instead of doc?)
That probably would be the most flexible option indeed to handle more sophisticated projects containing multiple packages with different documentation needs.
Currently
(generate_opam_files true)
will effectively unconditionally generate opam files, which include"odoc" {with-doc}
under depends and"@doc" {with-doc}
in build. There are packages, which often include no documentation: executable-only packages (#1496) or ppx packages (technically contain libraries, but not intended for usage as normal library). In such cases there are currently the following possibilities:odoc
dependency..mld
documentation for the executable/ppx such that the documentation wouldn't be completely pointless.Such practically unused documentations are especially visible in https://v3.ocaml.org/packages, even when the package itself intentionally doesn't publish documentation on GitHub Pages of its own repository or whereever. Manually written filler documentation (3. from above) is even less useful on the new site because the
README
is already shown, which for executables and ppxs likely already contains useful information. There wouldn't be any point maintaining an analogous.mld
document.Therefore, it would be useful to have a way to disable documentation dependency and generation for automatically produced opam files. Or possibly even have the option apply more generally to even the availability of the
@doc
alias, not just for opam file generation.Depending on the scope of the option, it could be a top-level stanza like
(documentation ...)
indune-project
or just an argument of(generate_opam_files ...)
instead of justtrue
.The text was updated successfully, but these errors were encountered: