Merge pull request #441 from knshnb/docstring-form-widget

Add docstring for FormWidgets

docs/_templates/autosummary/class.rst

@@ -0,0 +1,20 @@
+{% extends "!autosummary/class.rst" %}
+
+{#
+Ref: https://github.com/optuna/optuna/blob/41045cef7a8f5d0e5e4026bf0c5c649b269fc312/docs/source/_templates/autosummary/class.rst
+An autosummary template to exclude the class constructor (__init__)
+which doesn't contain any docstring in Optuna Dashboard.
+#}
+
+{% block methods %}
+   {% set methods = methods | select("ne", "__init__") | list %}
+   {% if methods %}
+   .. rubric:: Methods
+
+   .. autosummary::
+   {% for item in methods %}
+      ~{{ name }}.{{ item }}
+   {%- endfor %}
+   {% endif %}
+
+{% endblock %}

docs/api.rst

@@ -23,6 +23,7 @@ Human-in-the-loop
    :nosignatures:
 
    optuna_dashboard.register_objective_form_widgets
+   optuna_dashboard.register_user_attr_form_widgets
    optuna_dashboard.dict_to_form_widget
    optuna_dashboard.ChoiceWidget
    optuna_dashboard.SliderWidget

docs/conf.py

@@ -23,6 +23,7 @@ extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.autosummary",
+    "sphinx.ext.napoleon",
 ]
 
 templates_path = ["_templates"]