Generating docs #366
Merged
Generating docs #366
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
hairyhenderson
force-pushed
the
doc-generation-start
branch
2 times, most recently
from
7922ee6
to
f33237c
Compare
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
hairyhenderson
force-pushed
the
doc-generation-start
branch
from
f33237c
to
90365c7
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.
This is the beginning of an idea to generate the doc markdown in a more uniform way.
I have a vague awareness that Hugo (which I use for generating the doc site) may support something similar, but I don't know how it works, and I think I may be able to eventually generate other formats of docs (such as some man pages, as in #151?) from this...
At the very least, it'll help clean up the differences in formatting, and will probably give me a kick in the pants to better-document some of the older functions.
Signed-off-by: Dave Henderson dhenderson@gmail.com