embed executable code for demo

Author: fusawa-yugo

docs/source/conf.py

@@ -4,6 +4,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 from __future__ import annotations
 
+import plotly.io as pio
 from sphinx_gallery.sorting import FileNameSortKey
 
 
@@ -39,14 +40,20 @@
 html_logo = "_static/optuna-logo.png"
 html_css_files = ["css/custom.css"]
 
+# -- Sphinx Gallery configuration -------------------------------------------
+pio.renderers.default = "sphinx_gallery"
+
 sphinx_gallery_conf = {
     "examples_dirs": [
-        "../../recipes",
+        "../../recipes/contributors",
+        "../../recipes/users",
     ],
     "gallery_dirs": [
-        "generated/recipes",
+        "generated/contributors_recipes",
+        "generated/users_recipes",
     ],
     "within_subsection_order": FileNameSortKey,
     "filename_pattern": r"/*\.py",
     "first_notebook_cell": None,
+    "image_scrapers": ("matplotlib", "plotly.io._sg_scraper.plotly_sg_scraper"),
 }

docs/source/tutorials_for_contributors.rst

@@ -1,9 +1,9 @@
 Tutorials for Contributors
 ==========================
-- :doc:`generated/recipes/001_first`
-- :doc:`generated/recipes/002_registration`
-- :doc:`generated/recipes/003_pruner`
-- :doc:`generated/recipes/004_visualization`
-- :doc:`generated/recipes/005_debugging`
-- :doc:`generated/recipes/006_benchmarks_basic`
-- :doc:`generated/recipes/007_benchmarks_advanced`
+- :doc:`generated/contributors_recipes/001_first`
+- :doc:`generated/contributors_recipes/002_registration`
+- :doc:`generated/contributors_recipes/003_pruner`
+- :doc:`generated/contributors_recipes/004_visualization`
+- :doc:`generated/contributors_recipes/005_debugging`
+- :doc:`generated/contributors_recipes/006_benchmarks_basic`
+- :doc:`generated/contributors_recipes/007_benchmarks_advanced`

docs/source/tutorials_for_users/how_to_use_benchmarks.rst

@@ -5,4 +5,4 @@ Tutorials for Users
     :maxdepth: 1
 
     plot-in-optuna-dashboard
-    how_to_use_benchmarks
+    ../generated/users_recipes/001_how_to_use_benchmarks