Update documentation of account french chorus

2023-08-15 12:32:19 +02:00
parent 6dde3d7eb5
commit 9e7bbb97cf
7 changed files with 133 additions and 7 deletions
@@ -11,28 +11,36 @@ Version 6.6.0 - 2022-10-31
 * Bug fixes (see mercurial logs for details)

 Version 6.4.0 - 2022-05-02
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Add support for Python 3.10
 * Remove support for Python 3.6

 Version 6.2.0 - 2021-11-01
+--------------------------
 * Bug fixes (see mercurial logs for details)

 Version 6.0.0 - 2021-05-03
+--------------------------
 * Bug fixes (see mercurial logs for details)

 Version 5.8.0 - 2020-11-02
+--------------------------
 * Bug fixes (see mercurial logs for details)
 * Remove support for Python 3.5

 Version 5.6.0 - 2020-05-04
+--------------------------
 * Bug fixes (see mercurial logs for details)

 Version 5.4.0 - 2019-11-04
+--------------------------
 * Bug fixes (see mercurial logs for details)

 Version 5.2.0 - 2019-05-06
+--------------------------
 * Bug fixes (see mercurial logs for details)

 Version 5.0.0 - 2018-10-01
+--------------------------
 * Initial release
@@ -0,0 +1,39 @@
+******
+Design
+******
+
+The *Account French Chorus Module* introduces the following concepts:
+
+.. _model-account.invoice.chorus:
+
+Invoice Chorus
+==============
+
+The *Invoice Chorus* keeps track of the invoice sent to `Chorus Pro`_.
+
+.. seealso::
+
+   Invoices Chorus can be seen by opening the main menu item:
+
+      |Financial --> Invoices --> Customer Invoices --> Chorus|__
+
+      .. |Financial --> Invoices --> Customer Invoices --> Chorus| replace:: :menuselection:`Financial --> Invoices --> Customer Invoices --> Chorus`
+      __ https://demo.tryton.org./model/account.invoice.chorus
+
+.. _model-account.configuration:
+
+Configuration
+=============
+
+When the *Account French Chorus Module* is activated, the account configuration
+gain some extra properties.
+There includes the `Chorus Pro`_ and PISTE_ credentials and also the electronic
+syntax to use for documents.
+
+.. seealso::
+
+   The `Account Configuration <account:model-account.configuration>` concept is
+   introduced by the :doc:`Account Module <account:index>`.
+
+.. _Chorus Pro: https://chorus-pro.gouv.fr/
+.. _PISTE: https://piste.gouv.fr/
@@ -1,9 +1,14 @@
+############################
 Account French Chorus Module
 ############################

-The account_fr_chorus module allows to send invoices through the `Chorus Pro
-<https://chorus-pro.gouv.fr/>`_ portal.
+The *Account French Chorus Module* allows to send invoices through the `Chorus
+Pro <https://chorus-pro.gouv.fr/>`_ portal.

-If the party is checked for Chorus Pro, all posted customer invoices are queued to be sent.
-A cron job will send them every 15 minutes by default using the credential from
-the accounting configuration.
+.. toctree::
+   :maxdepth: 2
+
+   setup
+   usage
+   design
+   releases
@@ -0,0 +1,7 @@
+.. _releases-index:
+
+=============
+Release notes
+=============
+
+.. include:: ../CHANGELOG
@@ -0,0 +1,38 @@
+*****
+Setup
+*****
+
+.. _Connect to Chorus Pro:
+
+Connect to Chorus Pro
+=====================
+
+Tryton uses the API with `OAuth2 <https://en.wikipedia.org/wiki/OAuth#OAuth_2.0>`_.
+
+You must create a PISTE application for Tryton following the `User guide
+<https://developer.aife.economie.gouv.fr/en/help-center/guide>`_.
+The application must have access to these APIs:
+
+   * Factures
+   * Transverses
+
+You must now create a technical account following the `Connection to Chorus Pro
+guide
+<https://communaute.chorus-pro.gouv.fr/documentation/connection-to-chorus-pro/?lang=en>`_.
+And declare an API connection request by PISTE.
+
+You can not enter in the `Configuration <model-account.configuration>` the
+Chorus Pro :guilabel:`Login` and Chorus Pro :guilabel:`Password` of a technical
+account and :guilabel:`Piste Client ID` and :guilabel:`Piste Client Secret`
+from the `PISTE <https://piste.gouv.fr/>`_ connection.
+
+On the configuration you can also choose between the "Qualification" or the
+"Production" :guilabel:`Service` and the :guilabel:`Syntax`.
+
+.. note::
+   It may take few minutes before the API access is authorized.
+
+.. note::
+   Follow `Chorus Pro Quailification Portal
+   <https://communaute.chorus-pro.gouv.fr/documentation/chorus-pro-qualification-portal/?lang=en>`_
+   to create a dataset for testing.
@@ -0,0 +1,25 @@
+*****
+Usage
+*****
+
+.. _Setting a customer to send invoice to Chorus Pro:
+
+Setting a customer to send invoice to Chorus Pro
+================================================
+
+To send automatically `Customer Invoices
+<account_invoice:model-account.invoice>` through `Chorus Pro`_ , you must check
+the :guilabel:`Chorus Pro` checkbox on the customer `Party
+<party:model-party.party>` form.
+
+.. _Resent failing invoice:
+
+Resent failing invoice
+======================
+
+When an `Invoice <model-account.invoice.chorus>` is not accepted by `Chorus
+Pro`_, it is set to the "Exception" state.
+After fixing the data, you can resend the invoice by clicking on
+:guilabel:`Send` button.
+
+.. _Chorus Pro: https://chorus-pro.gouv.fr/
@@ -11,9 +11,12 @@ from setuptools import find_packages, setup


 def read(fname):
-    return io.open(
+    content = io.open(
        os.path.join(os.path.dirname(__file__), fname),
        'r', encoding='utf-8').read()
+    content = re.sub(
+        r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content)
+    return content


 def get_require_version(name):
@@ -63,7 +66,8 @@ setup(name=name,
    download_url=download_url,
    project_urls={
        "Bug Tracker": 'https://bugs.tryton.org/',
-        "Documentation": 'https://docs.tryton.org/',
+        "Documentation": (
+            'https://docs.tryton.org/projects/modules-account-fr-chorus'),
        "Forum": 'https://www.tryton.org/forum',
        "Source Code": 'https://code.tryton.org/tryton',
        },