Indices and tables

About this Documentation

This documentation is being developed to update and (eventually) replace the information in the following online guides, some of which may be available only to Questionmark customers:

Useful links:

This documentation is automatically generated using Sphinx from source code marked up with reStructuredText (see also Quick reStructuredText). You can find the full source in our GitHub Repository.

The items documented use a number of custom domains, the source of which is included in the above repository too. The following links have provided invaluable help in creating these custom domains:

  • Sphinx Domain API
  • Sphinx Source Documentation used in conjunction with the API docs to understand stuff used commonly in custom domain code.
  • Sphinx Source on GitHub these domains were very useful in understanding how to implement the required classes directly (as opposed to having them generated automatically as per the GNU Make Domain example referenced in many custom domain projects.
  • sphinx-contrib source code for a wide variety of custom domains
  • HTTP Custom Domain An interesting project with some more complex layouts, also reviewed as a potential model for documenting OData services
  • The Docutils Document Tree useful reading for doing the hard bits such as linking type definitions.
  • Documenting a language using a custom Sphinx domain... a useful starting point for showing what is possible though this follows the GNU Make Domain pattern which was not ultimately adopted in the custom domains used.