Cédric Krier pushed to branch branch/default at Tryton / Tryton
Commits:
12b3a6a5 by Cédric Krier at 2023-02-04T21:02:37+01:00
Apply sphinx-lint to documentation
- - - - -
7 changed files:
- .gitlab-ci.yml
- modules/product_cost_warehouse/doc/usage.rst
- modules/stock_supply/doc/index.rst
- trytond/doc/ref/backend.rst
- trytond/doc/ref/fields.rst
- trytond/doc/ref/transaction.rst
- trytond/doc/topics/configuration.rst
Changes:
=====================================
.gitlab-ci.yml
=====================================
@@ -53,6 +53,11 @@
variables:
DOC_BASE_URL: ${CI_PROJECT_DIR}/docs
DOC_DIR: doc
+ cache:
+ paths:
+ - .cache/pip/http
+ before_script:
+ - pip install sphinx-lint
script:
- cd "${PACKAGE}"
- python -m sphinx -T -E -W -n -b html ${DOC_DIR} _build/html
@@ -56,6 +61,7 @@
script:
- cd "${PACKAGE}"
- python -m sphinx -T -E -W -n -b html ${DOC_DIR} _build/html
+ - python -m sphinxlint ${DOC_DIR}
- |
if [ "${CHECK_LINK}" ]; then
python -m sphinx -T -E -W -n -b linkcheck ${DOC_DIR} _build;
=====================================
modules/product_cost_warehouse/doc/usage.rst
=====================================
@@ -27,7 +27,7 @@
.. _Viewing product cost prices:
Viewing product cost prices
-===========================
+===========================
With this module activated each `Product's <product:concept-product>` cost
price is shown based on your current `Company <company:model-company.company>`
=====================================
modules/stock_supply/doc/index.rst
=====================================
@@ -14,7 +14,7 @@
process will be triggered.
* The maximum quantity is the threshold quantity above which the overflowing
- process will be triggered.
+ process will be triggered.
* The target quantity is the quantity that will be found in the location after
the provisioning / overflowing process has been completed.
=====================================
trytond/doc/ref/backend.rst
=====================================
@@ -29,7 +29,7 @@
.. method:: Database.get_connection([autocommit[, readonly]])
- Retrieve a connection object as defined by :pep:249#connection.
+ Retrieve a connection object as defined by :pep:`249#connection`.
If autocommit is set, the connection is committed after each statement.
If readonly is set, the connection is read only.
@@ -172,8 +172,8 @@
.. method:: Database.sequence_update(connection, name[, number_increment[,
start_value]])
- Modify the named sequence with ``number_increment`` and ``start_value``using
- the ``connection``.
+ Modify the named sequence with ``number_increment`` and ``start_value``
+ using the ``connection``.
.. method:: Database.sequence_rename(connection, old_name, new_name)
=====================================
trytond/doc/ref/fields.rst
=====================================
@@ -601,7 +601,7 @@
.. classmethod:: Selection.get_selection(model, name, inst)
- Returns a :py:class`dictionary <dict>` mapping the selection value to its
+ Returns a :py:class:`dictionary <dict>` mapping the selection value to its
human-readable value.
.. classmethod:: Selection.get_selection_string(selection, value)
=====================================
trytond/doc/ref/transaction.rst
=====================================
@@ -72,7 +72,7 @@
.. staticmethod:: Transaction.monotonic_time
- Return a monotonic time used to populate :attr:~Transaction.started_at.
+ Return a monotonic time used to populate :attr:`~Transaction.started_at`.
.. method:: Transaction.start(database_name, user[, readonly[, context[,
close[, autocommit, \**extras]]]])
=====================================
trytond/doc/topics/configuration.rst
=====================================
@@ -639,7 +639,7 @@
It can be overridden for specific models and fields using the names:
``plugins-<model>-<field>`` or ``plugins-<model>``.
-Default: ``
+Default: ``''``
css
~~~
View it on Heptapod:
https://foss.heptapod.net/tryton/tryton/-/commit/12b3a6a52a84f3588a75c550441c2a2200f83433
--
View it on Heptapod:
https://foss.heptapod.net/tryton/tryton/-/commit/12b3a6a52a84f3588a75c550441c2a2200f83433
You're receiving this email because of your account on foss.heptapod.net.
