ICG Help with Sphinx System

This page indexes the unsystematic but surprisingly useful set of topics that have been written to assist the Itascan who is working with Sphinx. This documentation is an attempt to:

  1. provide reference information on Itasca’s additions to the Sphinx system. This takes the form of customizations that appear in the “fish.py” file. In there directives, roles, and arguments to existing directives have been defined to extend Sphinx to fit Itasca’s purposes. The work done there is documented here.
  2. provide further information (tips, if you like) to augment the documentation that is provided for reST and Sphinx by their respective owners. We have stumbled, painfully, upon omissions, inaccuracies, and the like in our work, and these topics are intended to spare new users that pain. It is strongly recommended that new users pass at least once quickly through these topics to avoid the gotchas that got us.