On 2/15/10 4:54 PM, Max Battcher wrote:
On 2/15/2010 19:25, Mark Harrison wrote:
What are the generated json files used for?
The json output is particularly well suited for dynamic web applications
that wish to plug the documentation into its own templates at the last
possible moment (for instance, so that the documentation better fits a
standard web template and can be subject to things like authorization
control, per-user navigation, etc...).
The biggest example in the wild is Django's documentation site
(docs.djangoproject.com) which uses the json files and basic Django
views to serve them (which are open source and you can examine them for
ideas on how to reuse/serve the json files).
I'm not sure what the point would be, but you could probably use the
json files to directly build a simple AJAX Sphinx documentation browser.
Certainly they could be also be useful in desktop clients, for instance
if you needed, for whatever reason, your own special "HTML Help
program"... Which is to say there are probably lots of uses someone
could come up with where having the data available in easy-to-parse json
might come in handy.
--
--Max Battcher--
http://worldmaker.net
ah, got it... Nice!
--
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en.
