Documentation

High-quality documentation is an essential part of MC/DC. Clear documentation supports simulation work, the development of computational methods, and the maintenance and evolution of the software framework.

This section explains both the philosophy behind MC/DC’s documentation and the tools used to build it.

Read Documentation Philosophy when deciding what information belongs in a page and how to layer it for different audiences. Read Sphinx and Read the Docs for source layout, reStructuredText, API generation, and local build instructions.

• Documentation Philosophy
• Sphinx and Read the Docs