init docs#102
Open
ZhiyuanChen wants to merge 1 commit into
Open
Conversation
Borda
suggested changes
May 11, 2020
Borda
left a comment
Borda
left a comment
Contributor
There was a problem hiding this comment.
I would suggest sphinx with autodoc instead of mkdocs
Owner
|
@Borda, what are your arguments? I am not familiar with either system. I've found no conclusive threads, but random opinions like this and that. According to this guide Sphinx seems to be considered a defacto standard. |
Contributor
|
The KMdocs is mostly static doc so you have to write everything compare to Sphinx is generated which is just taking you already well-documented code and create complete documentation... |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.