[Doc] Switch to pandoc and remove generated files #1955
Merged
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
|
Oops this whole lua transformation needs pandoc 2.17 and 22.04 is stuck on 2.9... This method has the advantage of giving a good layout on manpages, github preview and mkdocs. But the lua filter is a bit complicated. I also tried to rewrite the man files with definition lists but they don't render very well. Mkdocs is supposed to handle them but in practice it breaks if a code block is nested inside a definition. Solutions?
EDIT: went with the graceful degradation! |
hmm I guess something is wrong with my autoconf. The file appears when running EDIT: yes it was the wrong version check for pandoc. Gave up on it... |
* convert existing markup to use definition list (a bit hacky...) * rewrite title to pandoc man metadata * reduce heading nesting to match most man pages * inline code displayed as bold, also common man style
- autoconf: * generate in source directory if pandoc found * install from source directory - meson: * generate and install with build directory if pandoc found * try to install from source directory if pandoc not found * bail otherwise
Man pages look better with pandoc >= 2.17
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.
No description provided.