oceanbase / oceanbase/pyseekdb
[Feature]: publish api document on website
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 62
- Forks
- 35
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 2
Description
Describe your use case
Currently, we can view the API of pyseekdb from the code and can get the brief information from README.md. It's not convenient for developers.
We can generate API document by tools and publish on the website, for example github pages.
Describe the solution you'd like
Generate API docs and publish them on github pages.
Describe alternatives you've considered
No response
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Python API in the code and the existing README.md information to identify what needs to be documented. Determine how API documentation can be generated and published on GitHub Pages. Done means the generated API documentation is available on the project website and is more complete than the brief README.md coverage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100