Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

init docs #102

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

init docs #102

wants to merge 1 commit into from

Conversation

ZhiyuanChen
Copy link

No description provided.

Borda
Borda suggested changes May 11, 2020
View reviewed changes
Copy link
Contributor

@Borda Borda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest sphinx with autodoc instead of mkdocs

@cheind
Copy link
Owner

cheind commented May 12, 2020

@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.

@Borda
Copy link
Contributor

Borda commented May 12, 2020

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...

see Auto-Docs for Python

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Borda Borda Borda requested changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ZhiyuanChen @cheind @Borda