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

Improve documentation #17

Open
Arcadia822 opened this issue Jul 29, 2023 · 1 comment
Open

Improve documentation #17

Arcadia822 opened this issue Jul 29, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@Arcadia822
Copy link
Member

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 Arcadia822 added the documentation Improvements or additions to documentation label Aug 12, 2023
@Arcadia822
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Arcadia822