[sphinx-dev] how to keep most developer documentation with sphinx in source code? - are there good examples?

2010-06-25 Thread Evgeny
Hello, I'm trying to use sphinx for our project - askbot QA forum. Would really like to keep all developer documentation within the source code files, because I'm afraid that documentation in the external files is more likely to get out of sync with the real code. Is anyone doing this? Are there

Re: [sphinx-dev] how to keep most developer documentation with sphinx in source code? - are there good examples?

2010-06-25 Thread DasIch
You could use the autodoc extension, this way you can use the docstrings in the documentation. If you look at Sphinx itself you will see that the developer documentation consists only of the docstrings, the only written documentation is the one you can find on http://sphinx.pocoo.org. So I guess