From c1eb2435b6314412d7029acbf87efd63d84d384c Mon Sep 17 00:00:00 2001 From: Shagun Sodhani <1321193+shagunsodhani@users.noreply.github.com> Date: Wed, 2 Dec 2020 17:18:46 -0500 Subject: [PATCH] Group plugins in the documentation (#1176) --- website/sidebars.js | 22 ++++++--- .../version-1.0-sidebars.json | 48 ++++++++++++------- 2 files changed, 46 insertions(+), 24 deletions(-) diff --git a/website/sidebars.js b/website/sidebars.js index 45cbb9c3243..41cdec4cc8d 100755 --- 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 index 45f415014c4..53c295f3035 100644 --- 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": [] } ] -} +} \ No newline at end of file