[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)?
This commit is contained in:
Xavier Morel
2018-04-05 12:31:27 +02:00
parent 9b6ca49b58
commit 4e784adbf7
2 changed files with 42 additions and 18 deletions
+9 -11
View File
@@ -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/
.. _deferred: http://api.jquery.com/category/deferred-object/