Auto Generate Provider Documentation

.github/workflows/deploy-docs.yml

@@ -25,6 +25,7 @@ jobs:
           python mephisto/scripts/local_db/gh_actions/auto_generate_blueprint.py
           python mephisto/scripts/local_db/gh_actions/auto_generate_architect.py
           python mephisto/scripts/local_db/gh_actions/auto_generate_requester.py
+          python mephisto/scripts/local_db/gh_actions/auto_generate_provider.py
       - name: Install dependencies
         run: yarn install --frozen-lockfile
       - name: Build website

docs/web/docs/reference/providers.md

@@ -0,0 +1,34 @@
+
+
+
+
+# Provider
+
+
+The crowd provider determines the source of the crowd workers.
+## mock
+
+
+
+
+|dest|type|default|help|choices|required|
+| :--- | :--- | :--- | :--- | :--- | :--- |
+|requester_name|str|???|None|None|False|
+
+## mturk
+
+
+
+
+|dest|type|default|help|choices|required|
+| :--- | :--- | :--- | :--- | :--- | :--- |
+|requester_name|str|???|None|None|False|
+
+## mturk sandbox
+
+
+
+
+|dest|type|default|help|choices|required|
+| :--- | :--- | :--- | :--- | :--- | :--- |
+|requester_name|str|???|None|None|False|

mephisto/scripts/local_db/gh_actions/auto_generate_architect.py

@@ -8,7 +8,7 @@
 
 def main():
     architect_file = MdUtils(
-        file_name="../../../../docs/web/docs/reference/Architects.md",
+        file_name="../../../../docs/web/docs/reference/architects.md",
     )
     architect_file.new_header(level=1, title="Architects")
     valid_architect_types = get_valid_architect_types()

mephisto/scripts/local_db/gh_actions/auto_generate_blueprint.py

@@ -45,7 +45,7 @@ def create_blueprint_info(blueprint_file, arg_dict):
 
 def main():
     blueprint_file = MdUtils(
-        file_name="../../../../docs/web/docs/reference/Blueprints.md",
+        file_name="../../../../docs/web/docs/reference/blueprints.md",
     )
     blueprint_file.new_header(level=1, title="Blueprints")
     blueprint_file.new_paragraph("The blueprint determines the task content.")

mephisto/scripts/local_db/gh_actions/auto_generate_provider.py

@@ -0,0 +1,32 @@
+from mdutils.mdutils import MdUtils
+from mephisto.client.cli_commands import get_wut_arguments
+from mephisto.operations.registry import (
+    get_valid_provider_types,
+)
+from mephisto.scripts.local_db.gh_actions.auto_generate_blueprint import (
+    create_blueprint_info,
+)
+
+
+def main():
+    provider_file = MdUtils(
+        file_name="../../../../docs/web/docs/reference/providers.md",
+    )
+    provider_file.new_header(level=1, title="Provider")
+    provider_file.new_paragraph(
+        "The crowd provider determines the source of the crowd workers."
+    )
+    valid_provider_types = get_valid_provider_types()
+    for provider_type in valid_provider_types:
+        provider_file.new_header(level=2, title=provider_type.replace("_", " "))
+        args = get_wut_arguments(
+            ("provider={provider_name}".format(provider_name=provider_type),)
+        )
+        arg_dict = args[0]
+        create_blueprint_info(provider_file, arg_dict)
+
+    provider_file.create_md_file()
+
+
+if __name__ == "__main__":
+    main()

mephisto/scripts/local_db/gh_actions/auto_generate_requester.py

@@ -10,7 +10,7 @@
 
 def main():
     requester_file = MdUtils(
-        file_name="../../../../docs/web/docs/reference/Requester.md",
+        file_name="../../../../docs/web/docs/reference/requesters.md",
     )
     requester_file.new_header(level=1, title="Requesters")
     requester_file.new_paragraph("The requester is an account for a crowd provider.")