From 944755dd1d1e573bdf9c09f9da690c44d9fab946 Mon Sep 17 00:00:00 2001 From: Xavier Morel Date: Thu, 5 Apr 2018 12:26:27 +0200 Subject: [FIX] doc: non-module JS autodocumenters Also when there is both a docstring and directive-level content put the docstring first. That seems to match what Sphinx's autodoc does and looks less odd. Possible future improvement: a parameter to suppress the docstring? Possibly a way to reorder the non-docstring content (e.g. members documentation)? --- doc/reference/javascript_reference.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) (limited to 'doc/reference') diff --git a/doc/reference/javascript_reference.rst b/doc/reference/javascript_reference.rst index f27975742fe..b77aa9f5612 100644 --- a/doc/reference/javascript_reference.rst +++ b/doc/reference/javascript_reference.rst @@ -1,5 +1,9 @@ :banner: banners/javascript.jpg +.. highlight:: javascript + +.. default-domain:: js + ===================== Javascript Reference ===================== @@ -1644,19 +1648,13 @@ order. Relational fields ----------------- -- selection (FieldSelection) - The FieldSelection widget is a simple select tag with a dropdown menu to - allow the selection of a range of values. It is designed to work with fields - of type 'selection' and 'many2one'. When working with a many2one, it does - not allow the creation/edition of relational data. This is the default field - for selection fields. +.. autoclass:: web.relational_fields.FieldSelection - - Supported field types: *selection, many2one* + Supported field types: *selection*, *many2one* - Attributes: + .. attribute:: placeholder - - placeholder: a string which is used to display some info when no value is - selected + a string which is used to display some info when no value is selected .. code-block:: xml @@ -1816,4 +1814,4 @@ Relational fields .. _event delegation: http://api.jquery.com/delegate/ -.. _deferred: http://api.jquery.com/category/deferred-object/ \ No newline at end of file +.. _deferred: http://api.jquery.com/category/deferred-object/ -- cgit v1.2.3