Documenting RASCIL

  • The primary documentation is written in reStructuredText (rst).

  • We use Sphinx to extract code documentation.

  • We use the package sphinx_automodapi to build the API informatiom.

  • For this to work, all of the code must be loadable into python. To facilitate this, we make use of the dreaded from somewhere import *. This means that modules must use __all__ to only export those names that are delivered by that module, as oopposed to the other names used in the module.