On 2012-05-17, Ramon wrote: > We are defining an integration SDK that includes some fairly involved > parameter files, currently formatted in YAML syntax. I’d like to provide > “sample code” for these configurations (i.e. sample configuration files) as > well as detailed technical documentation on the format requirements (data > type constraints, etc). We are not wed to the YAML format yet, so if > another roughly equivalent format (e.g. JSON) is well-supported in Sphinx > we’d consider switching as getting the documentation in good shape to > encourage adoption by developers is a key goal.
> Are there any Sphinx approaches for documenting data structures or > parameter / configuration files like this? The PyLit bidirectional text/code converter can be used for "literate config files" in any config file syntax with documentation in reStructuredText. Pylit will convert the file from rst with code snippets to code with extensive comments and back. For an example config file, see http://pylit.berlios.de/conf.py.html Günter -- 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.
