add documentation for validator

openpype/hosts/maya/plugins/publish/validate_rendersettings.py

@@ -219,8 +219,7 @@ class ValidateRenderSettings(pyblish.api.InstancePlugin):
             instance.context.data["project_settings"]["maya"]["publish"]["ValidateRenderSettings"].get(  # noqa: E501
                 "{}_render_attributes".format(renderer))
         )
-        from pprint import pprint
-        pprint(validation_settings)
+
         # go through definitions and test if such node.attribute exists.
         # if so, compare its value from the one required.
         for attr, value in OrderedDict(validation_settings).items():

website/docs/admin_hosts_maya.md

@@ -0,0 +1,52 @@
+---
+id: admin_hosts_maya
+title: Maya
+sidebar_label: Maya
+---
+
+## Maya
+
+### Publish Plugins
+
+#### Render Settings Validator (`ValidateRenderSettings`)
+
+Render Settings Validator is here to make sure artists will submit renders
+we correct settings. Some of these settings are needed by OpenPype but some
+can be defined by TD using [OpenPype Settings UI](admin_settings).
+
+OpenPype enforced settings include:
+
+- animation must be enabled in output
+- render prefix must start with `maya/<scene>` to make sure renders are in
+correct directory
+- there must be `<renderlayer>` or its equivalent in different renderers in
+file prefix
+- if multiple cameras are to be rendered, `<camera>` token must be in file prefix
+
+For **Vray**:
+- AOV separator must be set to `_` (underscore)
+
+For **Redshift**:
+- all AOVs must follow `<BeautyPath>/<BeautyFile>_<RenderPass>` image file prefix
+- AOV image format must be same as the one set in Output settings
+
+For **Renderman**:
+- both image and directory prefixes must comply to `<layer>_<aov>.<f4>.<ext>` and `<ws>/renders/maya/<scene>/<layer>` respectively
+
+For **Arnold**:
+- there shouldn't be `<renderpass>` token when merge AOVs option is turned on
+
+
+Additional check can be added via Settings - **Project Settings > Maya > Publish plugin > ValidateRenderSettings**.
+You can add as many options as you want for every supported renderer. In first field put node type and attribute
+and in the second required value.
+
+![Settings example](assets/maya-admin_render_settings_validator.png)
+
+In this example we've put `aiOptions.AA_samples` in first one and `6` to second to enforce
+Arnolds Camera (AA) samples to 6.
+
+Note that `aiOptions` is not the name of node but rather its type. For renderers there is usually
+just one instance of this node type but if that is not so, validator will go through all its
+instances and check the value there. Node type for **VRay** settings is `VRaySettingsNode`, for **Renderman**
+it is `rmanGlobals`, for **Redshift** it is `RedshiftOptions`.

website/sidebars.js

@@ -82,7 +82,8 @@ module.exports = {
             type: "category",
             label: "Integrations",
             items: [
-                "admin_hosts_blender"
+                "admin_hosts_blender",
+                "admin_hosts_maya"
             ],
         },
         {