Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

documentation target and private_modules #2008

Closed
hannesm opened this issue Apr 2, 2019 · 0 comments · Fixed by ocaml/opam-repository#13860
Closed

documentation target and private_modules #2008

hannesm opened this issue Apr 2, 2019 · 0 comments · Fixed by ocaml/opam-repository#13860

Comments

@hannesm
Copy link
Member

hannesm commented Apr 2, 2019

When I use private_modules in a dune file, and run the dune build @doc target, the documentation is nicely generated, but the resulting index page includes the list of private modules.

This is with dune 1.8.2 and odoc 1.4.0

The generated html page (for mirleft/ocaml-x509#112) contains:

<p>This library exposes the following toplevel modules:</p><ul class="modules"><li><code>Asn_grammars</code></li><li><code>Registry</code></li><li><a href="X509/index.html"><code>X509</code></a></li><li><code>X509_authenticator</code></li><li><code>X509_ca</code></li><li><code>X509_certificate</code></li><li><code>X509_common</code></li><li><code>X509_crl</code></li><li><code>X509_crl_types</code></li><li><code>X509_encoding</code></li><li><code>X509_extension</code></li><li><code>X509_extension_types</code></li><li><code>X509_pem</code></li><li><code>X509_request_types</code></li><li><code>X509_types</code></li></ul>

I'm not sure whether this is an issue in odoc or dune (or am I missing some magic?).
rgrinberg added a commit to rgrinberg/jbuilder that referenced this issue Apr 2, 2019
@rgrinberg
List only public modules in generated index
f80a3a2 
Fix ocaml#2008

Signed-off-by: Rudi Grinberg <[email protected]>
@rgrinberg rgrinberg mentioned this issue Apr 2, 2019
Merged
rgrinberg added a commit to rgrinberg/jbuilder that referenced this issue Apr 2, 2019
@rgrinberg
List only public modules in generated index
b3ec401 
Fix ocaml#2008

Signed-off-by: Rudi Grinberg <[email protected]>
rgrinberg added a commit to rgrinberg/opam-repository that referenced this issue Apr 9, 2019
@rgrinberg
[new release] dune (1.9.0)
a369320 
CHANGES:

- Warn when generated `.merlin` does not reflect the preprocessing
  specification. This occurs when multiple stanzas in the same directory use
  different preprocessing specifications. This warning can now be disabled with
  `allow_approx_merlin` (ocaml/dune#1947, fix ocaml/dune#1946, @rgrinberg)

- Watch mode: display "Success" in green and "Had errors" in red (ocaml/dune#1956,
  @emillon)

- Fix glob dependencies on installed directories (ocaml/dune#1965, @rgrinberg)

- Add support for library variants and default implementations. (ocaml/dune#1900,
  @TheLortex)

- Add experimental `$ dune init` command. This command is used to create or
  update project boilerplate. (ocaml/dune#1448, fixes ocaml/dune#159, @shonfeder)

- Experimental Coq support (fix ocaml/dune#1466, @ejgallego)

- Install .cmi files of private modules in a `.private` directory (ocaml/dune#1983, fix
  ocaml/dune#1973 @rgrinberg)

- Fix `dune subst` attempting to substitute on directories. (ocaml/dune#2000, fix ocaml/dune#1997,
  @rgrinberg)

- Do not list private modules in the generated index. (ocaml/dune#2009, fix ocaml/dune#2008,
  @rgrinberg)

- Warn instead of failing if an opam file fails to parse. This opam file can
  still be used to define scope. (ocaml/dune#2023, @rgrinberg)

- Do not crash if unable to read a directory when traversing to find root
  (ocaml/dune#2024, @rgrinberg)

- Do not exit dune if some source directories are unreadable. Instead, warn the
  user that such directories need to be ignored (ocaml/dune#2004, fix ocaml/dune#310, @rgrinberg)

- Fix nested `(binaries ..)` fields in the `env` stanza. Previously, parent
  `binaries` fields would be ignored, but instead they should be combined.
  (ocaml/dune#2029, @rgrinberg)

- Allow "." in `c_names` and `cxx_names` (ocaml/dune#2036, fix ocaml/dune#2033, @rgrinberg)
rgrinberg added a commit to rgrinberg/opam-repository that referenced this issue Apr 9, 2019
@rgrinberg
[new release] dune (1.9.0)
33ce2ce 
CHANGES:

- Warn when generated `.merlin` does not reflect the preprocessing
  specification. This occurs when multiple stanzas in the same directory use
  different preprocessing specifications. This warning can now be disabled with
  `allow_approx_merlin` (ocaml/dune#1947, fix ocaml/dune#1946, @rgrinberg)

- Watch mode: display "Success" in green and "Had errors" in red (ocaml/dune#1956,
  @emillon)

- Fix glob dependencies on installed directories (ocaml/dune#1965, @rgrinberg)

- Add support for library variants and default implementations. (ocaml/dune#1900,
  @TheLortex)

- Add experimental `$ dune init` command. This command is used to create or
  update project boilerplate. (ocaml/dune#1448, fixes ocaml/dune#159, @shonfeder)

- Experimental Coq support (fix ocaml/dune#1466, @ejgallego)

- Install .cmi files of private modules in a `.private` directory (ocaml/dune#1983, fix
  ocaml/dune#1973 @rgrinberg)

- Fix `dune subst` attempting to substitute on directories. (ocaml/dune#2000, fix ocaml/dune#1997,
  @rgrinberg)

- Do not list private modules in the generated index. (ocaml/dune#2009, fix ocaml/dune#2008,
  @rgrinberg)

- Warn instead of failing if an opam file fails to parse. This opam file can
  still be used to define scope. (ocaml/dune#2023, @rgrinberg)

- Do not crash if unable to read a directory when traversing to find root
  (ocaml/dune#2024, @rgrinberg)

- Do not exit dune if some source directories are unreadable. Instead, warn the
  user that such directories need to be ignored (ocaml/dune#2004, fix ocaml/dune#310, @rgrinberg)

- Fix nested `(binaries ..)` fields in the `env` stanza. Previously, parent
  `binaries` fields would be ignored, but instead they should be combined.
  (ocaml/dune#2029, @rgrinberg)

- Allow "." in `c_names` and `cxx_names` (ocaml/dune#2036, fix ocaml/dune#2033, @rgrinberg)

- Format rules: if a dune file uses OCaml syntax, do not format it.
  (ocaml/dune#2014, fix ocaml/dune#2012, @emillon)
@rgrinberg rgrinberg mentioned this issue Apr 9, 2019
Merged
rgrinberg added a commit to rgrinberg/jbuilder that referenced this issue Apr 20, 2019
@rgrinberg
List only public modules in generated index
6519590 
Fix ocaml#2008

Signed-off-by: Rudi Grinberg <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[new release] dune (1.9.0) rgrinberg/opam-repository
1 participant
@hannesm