Skip to content

docs: add simple documentation for each tool#1

Open
flyingbucket wants to merge 1 commit intoFrederick2313072:mainfrom
flyingbucket:chore/docs-and-reading
Open

docs: add simple documentation for each tool#1
flyingbucket wants to merge 1 commit intoFrederick2313072:mainfrom
flyingbucket:chore/docs-and-reading

Conversation

@flyingbucket
Copy link
Copy Markdown

Documentations are organized with mkdocs,generally in google-docs stytle. Detailed contents are written in md files rather than docstrings.

thirdparty packages used in docks are updated in requirements.txt
checkout docs after installing dependencies by running this command under project root:

mkdocs serve

Documentations are organized with mkdocs,generally in google-docs
stytle. Detailed contents are written in md files rather than
docstrings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant