There's more…

Instead of having the long description in the module manifest, it's possible to have it in its own file. Since version 8.0, it can be replaced by a README file, with either a .txt, .rst, or an .md (Markdown) extension. Otherwise, include a description/index.html file in the module.

This HTML description will override a description defined in the manifest file.

There are a few more keys that are frequently used:

  • application: If this is True, the module is listed as an application. Usually, this is used for the central module of a functional area
  • auto_install: If this is True, it indicates that this is a "glue" module, which is automatically installed when all of its dependencies are installed
  • installable: If this is True (the default value), it indicates that the module is available for installation