doc: Use scdoc to write and generate man pages
#299
Merged
+785
−829
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
Antiz96
force-pushed
the
man_pages_scdoc
branch
9 times, most recently
from
a18842b to
1ef0692
Compare
`scdoc` is much more user friendly, simpler to read / write & more "digest" than `groff`. See #296 for the rational about the `scdoc` choice. Note that this introduces two new targets in the `Makefile`: - build (default target): Used to generate and archive the man pages (the generation of the `.mo` translation files has been moved here as well). - clean: Used to clean up the project directory of files man pages generated during build (the deletion of the generated `.mo` translation files has been moved here as well). Closes #296
Antiz96
force-pushed
the
man_pages_scdoc
branch
from
1ef0692 to
b67b748
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.
Description
scdocis much more user friendly, simpler to read / write & more "digest" thangroff.See #296 for the rational about the
scdocchoice.Note that this introduces two new targets in the
Makefile:.motranslation files has been moved here as well)..motranslation files has been moved here as well).Addressed feature request
Closes #296