From 402a65fe988be8d07d5b3da7cfc8d564aa3b5903 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Wed, 6 Apr 2022 18:19:49 +0200 Subject: [PATCH] Test building documentation issue11367 review397811002 --- .drone.yml | 5 +++++ doc/design.rst | 14 +++++++------- doc/index.rst | 4 ++-- doc/usage.rst | 2 +- 4 files changed, 15 insertions(+), 10 deletions(-) diff --git a/.drone.yml b/.drone.yml index 54fbe6947c..3522186566 100644 --- a/.drone.yml +++ b/.drone.yml @@ -30,6 +30,11 @@ pipeline: - pip install twine - python setup.py sdist - twine check dist/* + check_doc: + image: ${IMAGE] + commands: + - pip install sphinx + - python -m sphinx -T -E -W -n -b html doc _build/html services: postgresql: diff --git a/doc/design.rst b/doc/design.rst index b399cae778..06218fc64f 100644 --- a/doc/design.rst +++ b/doc/design.rst @@ -4,13 +4,13 @@ Design The *Web Shop Shopify Module* introduces some new concepts. -.. _model-web.shop.shopify_identifier +.. _model-web.shop.shopify_identifier: Shopify Identifier ================== A *Shopify Identifier* stores the Shopify ID for records from other models for -each different `Web Shop `. +each different :doc:`Web Shop `. .. seealso:: @@ -21,16 +21,16 @@ each different `Web Shop `. .. |Administration --> Models --> Shopify Identifiers| replace:: :menuselection:`Administration --> Models --> Shopify Identifiers` __ https://demo.tryton.org/model/web.shop.shopify_identifier -.. model-web.shop.shopify_payment_journal +.. _model-web.shop.shopify_payment_journal: Shopify Payment Journal ======================= The *Shopify Payment Journal* stores the rules which are used to determine on -which `Payment Journal ` the -transactions are entered. +which :doc:`Payment Journal ` the transactions are +entered. -.. model-stock.shipment.shopify_identifier +.. _model-stock.shipment.shopify_identifier: Shopify Shipment Identifier =========================== @@ -48,7 +48,7 @@ for each `Sale `. __ https://demo.tryton.org/model/stock.shipment.shopify_identifier -.. model-web.shop.shopify_inventory_item +.. _model-web.shop.shopify_inventory_item: Shopify Inventory Item ====================== diff --git a/doc/index.rst b/doc/index.rst index 7c2e391e7f..f85765eca1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -3,9 +3,9 @@ Web Shop Shopify Module ####################### The *Web Shop Shopify Module* provides a way to manage `Shopify -` stores. +`_ stores. It uploads products, variants and collections to Shopify, and downloads orders, -transactions and creates fulfillments. +transactions and creates fulfilments. .. toctree:: :maxdepth: 2 diff --git a/doc/usage.rst b/doc/usage.rst index 68ef35a326..77ae4f85f8 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -23,7 +23,7 @@ store with, as a minimum, the following permissions: You also need to copy the password that is generated. -When setting the `Web Shop `'s type to "Shopify", you +When setting the :doc:`Web Shop `'s type to "Shopify", you must fill in the "Shop URL" (e.g. ``https://.myshopify.com``) and the "Password" with the copied one.