README: MCSH Package Documentation

This directory contains the MCSH User Guide and Programming Manual. During the release process, this documentation gets packaged into the distribution files and published on the MCSH project site. You may find it faster and easier to visit that site and browse the documentation online.

reStructuredText

These documentation files have been written in reStructuredText, which is the same markup language used in the source code to produce the MCSH Reference Manual.

The tools required to build the documentation into its final form are supplied by the the MCSH package itself. Specifically, all of the files in docs/ are processed by i7, which transforms them into the desired documentation format. For more information, see the i7 docs command and the dev/docs/* libraries.

Altogether, the readable .rst files provide users with all of the documentation required to deploy the MCSH scripts in an offline environment. The inclusion of these documents in the source tree in a text-format ensures that users have the information on systems prior to connecting to the network. After all, the MCSH tools can create and configure new systems, and that is when you are likely to need the documentation the most.


View the Developer Guide Index

View the Reference Manual Index


Generated on Fri Jul 28 14:34:25 PDT 2017 by mcsh d14 v0.23.0.