Convert man pages to Markdown with YAML header #5594
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4273afd
to
4ff4dcf
Compare
4ff4dcf
to
f7d0961
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As we realized in #5593, the man pages also need to move to ocaml.org.
This patch adds a Makefile target to convert the man pages to Markdown with an ocaml.org-compatible YAML header using
pandoc.If preferred, I can omit the YAML header and we add that manually when embedding the docs into ocaml.org. Doing it this way, however, leaves less opportunity for human error in the process of moving the files to be hosted on ocaml.org.
Long-term, I think we want to generate the man pages as part of the odoc-generated manual for opam so the markdown target will probably have to be tweaked at that point to ensure compatibility with
odoc.