Auto-generate markdown documentation from inline docs #642
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
f649932 to
8eef4d0
Compare
d32040a to
c5190d4
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.
Addresses #622.
Since CocoaPods stopped automatically using CocoaDocs, I wanted to get something together which can get fed into our docs folder pretty easily. This uses SourceDocs to generate Markdown files which should be easily parseable by our CSS engine for documentation (and at the very least gives us the ability to refer to these docs in Markdown format).
Also added instructions for auto-generating the docs.
BE AWARE: There's gonna be a lot of stuff in here where the documentation is essentially "Well, this exists" because it's not commented inline. Gonna be working on improving that, but figured it was better to get this out as-is and gradually improve it.