Getting started writing documentation for a django application

Question

I would like to write documentation for one of my django based projects. I found that django uses reStructureText and Spinx for this purpose. I have the following queries.

• How do I start writing records using reStructureText and Sphinx?
• What are the best practices to keep your documentation organized, versioned, easy to understand, and easy to manage?

Thanks and Regards

Answer 1

Sphinx documentation is here: http://sphinx.pocoo.org/

• You start by running sphinx-quickstart .
• “Well organized” is really your own business. It depends on your taste and your project.
• "Easy to manage": include doctests in your code documentation and autodoc in sphinx settings. This way you can always see if your documentation matches your code when you run your test. (But use only the doctrine to test your documents, to verify your code, you must have separate unit tests, otherwise the documentation will be unusable ...)
• Regarding a “simple understanding," it really is up to you.