This repository has been archived by the owner on Aug 29, 2023. It is now read-only.

Technical Documentation Approach

Jump to bottom

Norman Fomferra edited this page May 20, 2016 · 4 revisions

Each use case will be described using a separate RST page (taken from URD) doc/sources/use_cases/use_case_.rst

Each processor / operation will be specified using a separate RST pages in doc/sources/op_specs/op_spec_.rst

Each Python module will have an introducing module-level doc-string with the following sections:

Module Description

bla

Module Requirements

bla

Module Reference

bla