codedog icon indicating copy to clipboard operation
codedog copied to clipboard

Improve documentation

Open Arcadia822 opened this issue 2 years ago • 1 comments

Is your feature request related to a problem? Please describe. Yes. Lack of document is a problem.

Describe the solution you'd like

  • readthedoc.

Describe alternatives you've considered

  • docstring auto generation.
  • find other solution.

Additional context

Arcadia822 avatar Jul 29 '23 16:07 Arcadia822

Instead of using sphinx. I found another package pdoc which can generate api refenerence documents just from comment string. where is perfect simple and clear.

Arcadia822 avatar Aug 21 '23 07:08 Arcadia822