[IMP] README, :fields: -> :only: in demo:fields::
This commit is contained in:
parent
1577f53246
commit
5b2942ad58
93
README.rst
93
README.rst
@ -5,13 +5,24 @@ End-user Odoo documentation
|
|||||||
Building requirements:
|
Building requirements:
|
||||||
|
|
||||||
* Python 2.7
|
* Python 2.7
|
||||||
* recent `Sphinx <http://sphinx-doc.org>`_
|
* recent `Sphinx <http://sphinx-doc.org>`_ (at least Sphinx 1.2)
|
||||||
|
|
||||||
After checking out, at the root of the documentation just type ``make
|
you can check if Sphinx is installed by trying to launch
|
||||||
html``, the HTML content will be built to ``_build/html/index.html``.
|
|
||||||
|
|
||||||
Edition
|
.. code-block:: console
|
||||||
=======
|
|
||||||
|
$ sphinx-build --version
|
||||||
|
|
||||||
|
After checking out, at the root of the documentation just type
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ make html
|
||||||
|
|
||||||
|
the HTML content will be built to ``_build/html/index.html``.
|
||||||
|
|
||||||
|
Contributions
|
||||||
|
=============
|
||||||
|
|
||||||
For simple edition (typo, just add paragraphs of text without markup),
|
For simple edition (typo, just add paragraphs of text without markup),
|
||||||
the Github web interface can be used directly.
|
the Github web interface can be used directly.
|
||||||
@ -20,7 +31,77 @@ For more complex edition, to add images or advanced directives, edit
|
|||||||
locally. **Do not commit if there are warnings or errors when building
|
locally. **Do not commit if there are warnings or errors when building
|
||||||
the documentation** fix them first. rST is fairly sensitive to
|
the documentation** fix them first. rST is fairly sensitive to
|
||||||
whitespace and newlines (especially the lack of newlines). It's a bit
|
whitespace and newlines (especially the lack of newlines). It's a bit
|
||||||
annoying but it's not hard to learn...
|
annoying but it's not hard to learn.
|
||||||
|
|
||||||
|
Issues can be reported on the repository's bug tracker as usual.
|
||||||
|
|
||||||
|
Custom features
|
||||||
|
===============
|
||||||
|
|
||||||
|
Extensions
|
||||||
|
----------
|
||||||
|
|
||||||
|
Two custom directives are provided for integration with Odoo's demo
|
||||||
|
system:
|
||||||
|
|
||||||
|
* :samp:`demo:fields:: {external_id}` lists all the fields with a
|
||||||
|
tooltip (``help``) of the action whose ``external_id`` is provided.
|
||||||
|
|
||||||
|
- Uses the ``form`` view by default, can be customized by specifying
|
||||||
|
``:view:``.
|
||||||
|
- The list of fields displayed can be filtered with ``:only:`` which
|
||||||
|
should be a list of space-separated fields to display. Note that
|
||||||
|
this will further reduce the number of fields displayed, it will
|
||||||
|
not force fields to be listed when they don't have a ``help``.
|
||||||
|
|
||||||
|
.. code-block:: restructuredtext
|
||||||
|
|
||||||
|
.. demo:fields:: account_asset.action_account_asset_asset_list_normal_sale
|
||||||
|
:only: name
|
||||||
|
|
||||||
|
will display a table of just the ``name`` field and its ``help`` (or
|
||||||
|
nothing if the ``name`` field does not have a ``help``)
|
||||||
|
|
||||||
|
* :samp:`demo:action:: {external_id}` will create a link button to the
|
||||||
|
action (specified by external id) on the demo site. The text of the
|
||||||
|
button should be provided as the directive's content:
|
||||||
|
|
||||||
|
.. code-block:: restructuredtext
|
||||||
|
|
||||||
|
.. demo:action:: account_asset.action_account_asset_asset_list_normal_sale
|
||||||
|
|
||||||
|
View *Asset Types*
|
||||||
|
|
||||||
|
Theme Customisations
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
* The Odoo theme supports *Banner Images* at the top of
|
||||||
|
documents. These banners are configured by setting a ``:banner:``
|
||||||
|
field at the top of the document (before the page title), the banner
|
||||||
|
images will be looked up in the ``_static`` folder at the root of
|
||||||
|
the project
|
||||||
|
|
||||||
|
.. code-block:: restructuredtext
|
||||||
|
|
||||||
|
:banner: banners/accounting.png
|
||||||
|
|
||||||
|
==========
|
||||||
|
Accounting
|
||||||
|
==========
|
||||||
|
|
||||||
|
[...]
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
because banners are wide images and each page may have one, it is
|
||||||
|
strongly recommended to compress them well. For PNG, use
|
||||||
|
`pngquant <https://pngquant.org>`_ (or a UI to it) to reduce the
|
||||||
|
number of colors in the image followed by regular PNG
|
||||||
|
recompression tools like `pngcrush
|
||||||
|
<http://pmt.sourceforge.net/pngcrush/>`_ and `pngout
|
||||||
|
<http://www.advsys.net/ken/util/pngout.htm>`_.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Importing existing documents
|
Importing existing documents
|
||||||
============================
|
============================
|
||||||
|
@ -29,7 +29,7 @@ class Fields(Directive):
|
|||||||
required_arguments = 1
|
required_arguments = 1
|
||||||
option_spec = {
|
option_spec = {
|
||||||
'view': directives.unchanged,
|
'view': directives.unchanged,
|
||||||
'fields': directives.unchanged,
|
'only': directives.unchanged,
|
||||||
}
|
}
|
||||||
def __init__(self, name, arguments, options, content, lineno,
|
def __init__(self, name, arguments, options, content, lineno,
|
||||||
content_offset, block_text, state, state_machine):
|
content_offset, block_text, state, state_machine):
|
||||||
@ -50,7 +50,7 @@ class Fields(Directive):
|
|||||||
return [self.state_machine.reporter.warning(
|
return [self.state_machine.reporter.warning(
|
||||||
"Could not find any field related to the action [%s]" % self.arguments[0]
|
"Could not find any field related to the action [%s]" % self.arguments[0]
|
||||||
)]
|
)]
|
||||||
whitelist = set(filter(None, self.options.get('fields', '').split(',')))
|
whitelist = set(self.options.get('only', '').split(''))
|
||||||
return [nodes.field_list('', *(
|
return [nodes.field_list('', *(
|
||||||
nodes.field('',
|
nodes.field('',
|
||||||
nodes.field_name(text=v['string'] or k),
|
nodes.field_name(text=v['string'] or k),
|
||||||
|
Loading…
Reference in New Issue
Block a user