Documentation is hard to find #3

Closed
sztomi opened this Issue Apr 27, 2012 · 11 comments

Comments

Projects
None yet
6 participants

sztomi commented Apr 27, 2012

I found this though I don't know if it's up-to-date, but certainly not easy to find. I think you could set up a simple git hook for generating and pushing the docs to the website (since the code itself has doc comments).

Owner

jeanphix commented Apr 28, 2012

For now the documentation is at http://jeanphix.me/Ghost.py/

I'll work on something cleaner later.

sztomi commented Apr 28, 2012

Actually I meant a reference-style documentation rather than a tutorial-kind.

Owner

jeanphix commented Apr 28, 2012

I think both (quick start and samples + auto generated API) should be great.

sztomi commented Apr 30, 2012

Yes, I agree that both is great to have, but the complaint was only about the ref. doc., the other one was not hard to find :)

abunsen commented Aug 13, 2012

How can I help improve the documentation? I'm interested in using ghost.py for testing.

readthedoc hook maybe?

Contributor

osleg commented Dec 2, 2012

There IS a autogenerated API? Can we have link in readme? :)

Contributor

reustle commented Feb 18, 2013

@jeanphix Can you please add a repo (or folder in this repo) for http://jeanphix.me/Ghost.py/ so we can help improve it?

Thanks!

Owner

jeanphix commented Feb 18, 2013

@reustle The documenation is within branch gh-pages

Contributor

reustle commented Feb 18, 2013

Ok thanks, I wouldn't have found that myself. You might want to consider pulling into a more visible place (eg. /gh-pages/ on master), to make it even easier for people who want to contribute.

Owner

jeanphix commented Dec 10, 2014

Doc has been moved to RTD http://ghost-py.readthedocs.org/en/latest/

jeanphix closed this Dec 10, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment