Documentation - multiply-org/multiply-core GitHub Wiki

README.md

For each repository, there shall be a README.md file in the main folder. This file will serve as first point of information for users and/or developers coming to a component of the MULTIPLY platform. The file should contain the following:

• A short description of the repository, including a link to the main documentation ( http://multiply.readthedocs.io/en/latest/ )
• A list of the content with short descriptions
• An installation guide
• A user guide
• The License

Note that these might partially overlap with the information to be provided in the main documentation (see the following chapter).

Read the Docs

The documentation of the MULTIPLY platform shall be written into the doc folders at multiply-core. The files are in restructuredText-Format ( rst, https://en.wikipedia.org/wiki/ReStructuredText ) . For each component, there shall be

• a description of what it does
• a specification of its input
• a specification of its output
• a specification of its interfaces (command line and API)
• further requirements, such as dependencies to other software or required ressources

There also shall be general sections explaining what the MULTIPLY platform is about, how the different components come together, and how it can be set up and used. The structure already exists and there are rst-files for the various components (empty at the time of writing). The documentation can be extended to include more files. It is available online at http://multiply.readthedocs.io/en/latest/ .

The repository managers are responsible for setting up the documentation of their respective components.

Each repository manager is free to create documentation in their repository. To do so, it is advised to use Sphinx ( http://www.sphinx-doc.org/en/stable/ ).