django-imagekit
django-imagekit copied to clipboard
Add Specific Reference Documentation
As discussed in #209, it would be nice to use autodoc to document all of the public classes and their methods. I have never used autodoc before, but have started looking at an example project, and its resulting documention.
@matthewwithanm do you have any particular setup you like for using autodoc, or any conventions to follow?
- [ ] add autodoc generation
- [ ] add links to methods within the rest of the documentation
- [ ] document all classes and methods properly
No, I don't have that much experience with it either. You can check out what we did in 2.X though for some ideas. Basically, as long as it's integrated with the normal docs like that, it's cool.