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

Write documentation #4

Open
Akuryou opened this issue Dec 9, 2014 · 3 comments
Open

Write documentation #4

Akuryou opened this issue Dec 9, 2014 · 3 comments

Comments

@Akuryou
Copy link
Member

Akuryou commented Dec 9, 2014

No description provided.

@edwinlunando
Copy link

hi! i would like to help you to make documentation, do you have any tips for me?

@Akuryou
Copy link
Member Author

Akuryou commented Mar 23, 2015

Hi!

Thank you for your offer, very kind of you.

I'd say the minimal version would be something like I did here:
https://github.com/byteweaver/django-referral

Better would be something you can publish to read the docs and maybe using Sphinx.
But I didn't have time yet to look into that.

@noxan
Copy link
Member

noxan commented Mar 23, 2015

Sphinx should be a good point to start with. The official tutorial is worth having a look: http://sphinx-doc.org/tutorial.html
And a small example of some documentation for on of our apps can be found here: https://github.com/byteweaver/django-genesis/tree/sphinx-docs/docs
With the results published to read-the-docs: https://django-genesis.readthedocs.org/en/latest/

Hope those links provide you some help and I would be very glad to see your results. Let us know if we could assist you with your efforts :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants