From 2f83e5a2dbd734e858f1e7acff2c6b9d0928a467 Mon Sep 17 00:00:00 2001 From: BO ZHANG Date: Mon, 10 Oct 2022 12:07:46 +0800 Subject: [PATCH] updated structure --- doc/source/cicd.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/cicd.rst b/doc/source/cicd.rst index b690174..c0dfd04 100644 --- a/doc/source/cicd.rst +++ b/doc/source/cicd.rst @@ -26,13 +26,13 @@ Still Failing ``build log`` explained ----------------------- -The build log includes several sections on +The build log includes 6 sections. -1. a check on versions of requirements +Check on versions of requirements The status will be non-zero if any of your requirements is behind other developers. -2. a check on installation of requirements +Check on installation of requirements The status will be non-zero if ``pip install -r requirements.txt`` exit with non-zero status. -3. a check on installation of package +Check on installation of package The status will be non-zero if the following code are unsuccessfully executed .. code-block:: bash @@ -42,21 +42,21 @@ The build log includes several sections on python setup.py sdist # build source code pip install dist/*.tar.gz --force-reinstall --no-deps # install package without dependencies -4. a check on import of interfaces (top_level_interface) +Check on import of interfaces (``top_level_interface``) The status will be non-zero if the following code are unsuccessfully executed .. code-block:: python from .top_level_interface import * -5. unit tests and coverage +Run unit tests and coverage The status will be non-zero if the following code are unsuccessfully executed .. code-block:: bash coverage run -m pytest --import-mode=importlib -6. Numpydoc validation of interfaces +``Numpydoc`` validation of interfaces .. code-block:: bash -- GitLab