Apply sphinx-lint to documentation
This commit is contained in:
@@ -53,9 +53,15 @@ documentation:
|
||||
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
|
||||
- python -m sphinxlint ${DOC_DIR}
|
||||
- |
|
||||
if [ "${CHECK_LINK}" ]; then
|
||||
python -m sphinx -T -E -W -n -b linkcheck ${DOC_DIR} _build;
|
||||
|
||||
@@ -27,7 +27,7 @@ prices is configured to run for each different warehouse.
|
||||
.. _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>`
|
||||
|
||||
@@ -14,7 +14,7 @@ location.
|
||||
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.
|
||||
|
||||
@@ -29,7 +29,7 @@ Database
|
||||
|
||||
.. 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 @@ Database
|
||||
|
||||
.. 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)
|
||||
|
||||
|
||||
@@ -601,7 +601,7 @@ Class methods:
|
||||
|
||||
.. 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)
|
||||
|
||||
@@ -72,7 +72,7 @@ Transaction
|
||||
|
||||
.. 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]]]])
|
||||
|
||||
|
||||
@@ -639,7 +639,7 @@ The space separated list of TinyMCE plugins to load.
|
||||
It can be overridden for specific models and fields using the names:
|
||||
``plugins-<model>-<field>`` or ``plugins-<model>``.
|
||||
|
||||
Default: ``
|
||||
Default: ``''``
|
||||
|
||||
css
|
||||
~~~
|
||||
|
||||
Reference in New Issue
Block a user