diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/web-servers/uwsgi.nix')
-rw-r--r-- | nixpkgs/nixos/modules/services/web-servers/uwsgi.nix | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix b/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix index 5b9fc0e79d9f..377c7720d6ee 100644 --- a/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix +++ b/nixpkgs/nixos/modules/services/web-servers/uwsgi.nix @@ -75,13 +75,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = "Enable uWSGI"; + description = lib.mdDoc "Enable uWSGI"; }; runDir = mkOption { type = types.path; default = "/run/uwsgi"; - description = "Where uWSGI communication sockets can live"; + description = lib.mdDoc "Where uWSGI communication sockets can live"; }; package = mkOption { @@ -124,37 +124,37 @@ in { }; } ''; - description = '' - uWSGI configuration. It awaits an attribute <literal>type</literal> inside which can be either - <literal>normal</literal> or <literal>emperor</literal>. + description = lib.mdDoc '' + uWSGI configuration. It awaits an attribute `type` inside which can be either + `normal` or `emperor`. - For <literal>normal</literal> mode you can specify <literal>pythonPackages</literal> as a function - from libraries set into a list of libraries. <literal>pythonpath</literal> will be set accordingly. + For `normal` mode you can specify `pythonPackages` as a function + from libraries set into a list of libraries. `pythonpath` will be set accordingly. - For <literal>emperor</literal> mode, you should use <literal>vassals</literal> attribute + For `emperor` mode, you should use `vassals` attribute which should be either a set of names and configurations or a path to a directory. Other attributes will be used in configuration file as-is. Notice that you can redefine - <literal>plugins</literal> setting here. + `plugins` setting here. ''; }; plugins = mkOption { type = types.listOf types.str; default = []; - description = "Plugins used with uWSGI"; + description = lib.mdDoc "Plugins used with uWSGI"; }; user = mkOption { type = types.str; default = "uwsgi"; - description = "User account under which uWSGI runs."; + description = lib.mdDoc "User account under which uWSGI runs."; }; group = mkOption { type = types.str; default = "uwsgi"; - description = "Group account under which uWSGI runs."; + description = lib.mdDoc "Group account under which uWSGI runs."; }; capabilities = mkOption { @@ -179,8 +179,7 @@ in { <para> When in Emperor mode, any capability to be inherited by a vassal must be specified again in the vassal configuration using <literal>cap</literal>. - See the uWSGI <link - xlink:href="https://uwsgi-docs.readthedocs.io/en/latest/Capabilities.html">docs</link> + See the uWSGI <link xlink:href="https://uwsgi-docs.readthedocs.io/en/latest/Capabilities.html">docs</link> for more information. </para> </note> |