search

zgzgorg / iam-backend

0 stars 2 forks source link

implement automation generate documentation #40

Open kis87988 opened 2 years ago

kis87988 commented 2 years ago

We should have automation generate documentation Our docstring style follows google style.

Outcome:

  1. generate docs file by make docs
  2. make sure it can read google style docstring
  3. can choose Markdown, HTML format
  4. research some tools such as Sphinx, sphinx-markdown-builder, and recommonmark

Reference: https://github.com/kis87988/Python_Google_docstring/