8000 Fix issue #610 - `odoc html-fragment` not producing headings correctly by jonludlam · Pull Request #1306 · ocaml/odoc · GitHub
[go: up one dir, main page]
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

Fix issue #610 - odoc html-fragment not producing headings correctly #1306

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix issue #610 - odoc html-fragment not producing headings correctly #1306

wants to merge 2 commits into from

Conversation

jonludlam
Copy link
Member

@dbuenzli could you please check this works for you? As a quick check, with this I get:

$ echo "{0:sample OCaml 4.11.1 sample package documentation}" > frag.mld 
$ dune exec -- odoc html-fragment frag.mld  
<h1 id="sample"><a href="#sample" class="anchor"></a>OCaml 4.11.1 sample package documentation</h1>

@dbuenzli
Copy link
Contributor
dbuenzli commented Feb 7, 2025

Works as you mention.

panglesd
panglesd reviewed Feb 18, 2025
View reviewed changes
Copy link
Collaborator
@panglesd panglesd left a comment

Choose a reason for hiding this comment

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

I was wondering where Odoc_html.Generator.doc is used to remove it/find related bugs, and it seems to be used only here. And I think this code has same problem (headings are turned into paragraphs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@panglesd panglesd panglesd left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jonludlam @dbuenzli @panglesd
0