Group plugins in the documentation (#1176)

facebookresearch · Dec 2, 2020 · c1eb243 · c1eb243
1 parent 4d759d5
commit c1eb243
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 24 deletions.
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -83,14 +83,22 @@ module.exports = {
         ],
 
         'Plugins': [
-            'plugins/ax_sweeper',
             'plugins/colorlog',
-            'plugins/joblib_launcher',
-            'plugins/nevergrad_sweeper',
-            'plugins/optuna_sweeper',
-            'plugins/ray_launcher',
-            'plugins/rq_launcher',
-            'plugins/submitit_launcher',
+            {
+                'Launchers': [
+                    'plugins/joblib_launcher',
+                    'plugins/ray_launcher',
+                    'plugins/rq_launcher',
+                    'plugins/submitit_launcher',
+                ]
+            },
+            {
+                'Sweepers': [
+                    'plugins/ax_sweeper',
+                    'plugins/nevergrad_sweeper',
+                    'plugins/optuna_sweeper',
+                ]
+            },
         ],
 
         'Reference manual': [

diff --git a/website/versioned_sidebars/version-1.0-sidebars.json b/website/versioned_sidebars/version-1.0-sidebars.json
@@ -200,29 +200,43 @@
       "type": "category",
       "label": "Plugins",
       "items": [
-        {
-          "type": "doc",
-          "id": "version-1.0/plugins/ax_sweeper"
-        },
         {
           "type": "doc",
           "id": "version-1.0/plugins/colorlog"
         },
         {
-          "type": "doc",
-          "id": "version-1.0/plugins/joblib_launcher"
-        },
-        {
-          "type": "doc",
-          "id": "version-1.0/plugins/nevergrad_sweeper"
-        },
-        {
-          "type": "doc",
-          "id": "version-1.0/plugins/rq_launcher"
+          "collapsed": true,
+          "type": "category",
+          "label": "Launchers",
+          "items": [
+            {
+              "type": "doc",
+              "id": "version-1.0/plugins/joblib_launcher"
+            },
+            {
+              "type": "doc",
+              "id": "version-1.0/plugins/rq_launcher"
+            },
+            {
+              "type": "doc",
+              "id": "version-1.0/plugins/submitit_launcher"
+            }
+          ]
         },
         {
-          "type": "doc",
-          "id": "version-1.0/plugins/submitit_launcher"
+          "collapsed": true,
+          "type": "category",
+          "label": "Sweepers",
+          "items": [
+            {
+              "type": "doc",
+              "id": "version-1.0/plugins/ax_sweeper"
+            },
+            {
+              "type": "doc",
+              "id": "version-1.0/plugins/nevergrad_sweeper"
+            }
+          ]
         }
       ]
     },
@@ -355,4 +369,4 @@
       "items": []
     }
   ]
-}
+}