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.

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

Better, more comprehensive documentation #83

Closed
denibertovic opened this issue Nov 7, 2013 · 9 comments
Closed

Better, more comprehensive documentation #83

denibertovic opened this issue Nov 7, 2013 · 9 comments

Comments

@denibertovic
Copy link
Contributor

We talked about doing better docs so I'm opening this issue as reminder... so it bugs us and we don't forget.

@denibertovic
Copy link
Contributor Author

I propose we use sphinx and host the docs on readthedocs.org (but i'm open to other suggestions).

I think I'm going to have some time this weekend to work on this.

If anyone has any ongoing work in this regards, now's the time to speak up. :)

@tlindener
Copy link

Hi, I'm currently trying to get started with docker-py but I don't really get the results I get with running the native commands.
I would be very grateful to get some more documentation on how this works :-)

@shin-
Copy link
Contributor

shin- commented Apr 11, 2014

@tlindener Until we have good docs, I'd advise putting our README.md and the remote API docs side by side, which should (hopefully) clarify those differences.

@bsdlp
Copy link

bsdlp commented Jun 29, 2014

volume usage is ambiguous in the readme.

are the volumes defined in create_container paths on the host or in the container?

@micahhausler
Copy link

I'll be building out sphinx docs today

@micahhausler
Copy link

@shin- @mpetazzoni

Would you all like a PR to the master branch or an enhancement/documentation branch?

@shreyaskarnik
Copy link
Contributor

@micahhausler +1

shin- added a commit that referenced this issue Oct 29, 2014
@denibertovic
Copy link
Contributor Author

@shin- can we close this issue?

@shin-
Copy link
Contributor

shin- commented Oct 29, 2014

I believe so!

@shin- shin- closed this as completed Oct 29, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants