[Epic] Better documentation
Open
@shin- is already working on this.
Since Nov 3, 2015.
group/documentation
kind/epic
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
- #454 Making use of Sphinx autodoc for API docs
- #499 Document possible exceptions
- #821 Clean up documentation
- #964 #943 Documentation for
ulimitsand logging configuration is absent / lacking - https://github.com/docker/docker-py/pull/1083#issuecomment-225746644 Network documentation / thematic separation for API docs.
Main takeaways:
- API docs are poorly formatted and difficult to navigate.
- Some users find it valuable to have the documentation closer to the code itself.
- More information could be given about the behavior of our methods (exceptions raised, etc.)
- User guides in addition to functional documentation could prove useful.
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.
Assessment
This issue has not been assessed yet.