Skip to content

Add a class and a css rule for empty includes#798

Merged
jonludlam merged 1 commit intoocaml:masterfrom
panglesd:fix-725
Dec 16, 2021
Merged

Add a class and a css rule for empty includes#798
jonludlam merged 1 commit intoocaml:masterfrom
panglesd:fix-725

Conversation

@panglesd
Copy link
Copy Markdown
Collaborator

@panglesd panglesd commented Dec 14, 2021

This PR propose a fix of #725.

It adds a class "shadowed-include" to the html element containing an empty include.
This way, it is easy to change how these elements are displayed without changing odoc itself, just adding css.
By default, in this PR, it is not displayed.
However, the first suggestion of @asavahista on #725, of having a special formatting for these, could be implemented as well.

Signed-off-by: Paul-Elliot <peada@free.fr>
Copy link
Copy Markdown
Contributor

@Drup Drup left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds like a reasonable solution 👍

@jonludlam jonludlam merged commit 816710a into ocaml:master Dec 16, 2021
jonludlam added a commit to jonludlam/opam-repository that referenced this pull request Feb 8, 2022
CHANGES:

Additions
- New subcommand to resolve references (@panglesd, @lubega-simon, ocaml/odoc#812)
- Improved rendering of long signatures (@panglesd, ocaml/odoc#782)
- Handle comments attached to open statement as floating comment, instead
  of dropping them (@panglesd, ocaml/odoc#797)
- Empty includes (containing entirely shadowed entries) are now hidden (@panglesd, ocaml/odoc#798)

Bugs fixed
- Fix a missing Result constructor during compile. This will cause some
  functor arguments to have different filenames (@jonludlam, ocaml/odoc#795)
- Better memory/disk space usage when handling module alias chains (@jonludlam, ocaml/odoc#799)
- Resolving class-type paths (ie., `val x : #c`) (@jonludlam, ocaml/odoc#809)
- Skip top-level attributes while extracting the top comment. Fix top-comment extraction with PPX preprocessing (@jorisgio, ocaml/odoc#819)
- Better handling of @canonical tags (@jonludlam, ocaml/odoc#820)
- css: improved layout (@jonludlam, @Julow, ocaml/odoc#822)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants