From ea2ade78271914fa5dc65e73d8d4da0367e9f90c Mon Sep 17 00:00:00 2001
From: BO ZHANG <bozhang@nao.cas.cn>
Date: Sun, 9 Oct 2022 10:20:29 +0800
Subject: [PATCH] minor changes

---
 doc/source/cicd.rst                         | 14 +++++++++++++-
 doc/source/conf.py                          |  2 +-
 doc/source/csst_common/csst_common.rst      |  2 +-
 doc/source/csst_common/example_interface.py |  3 ++-
 doc/source/index.rst                        |  4 ++--
 5 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/doc/source/cicd.rst b/doc/source/cicd.rst
index 9d4dd32..db1cbd6 100644
--- a/doc/source/cicd.rst
+++ b/doc/source/cicd.rst
@@ -113,4 +113,16 @@ The Numpy style docstring check is only for the packages listed below.
 - csst_ms_mbi_flux
 - csst_ms_mbi_photometry
 
-We welcome other packages participate in.
\ No newline at end of file
+We welcome other packages participate in.
+
+
+Using ``Jenkins``
+-----------------
+
+... how to use jenkins
+
+
+Docker and Kubernetes
+---------------------
+
+to be updated
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 18892d8..0b547f6 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -17,7 +17,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Guides for CSST DAS Developers'
+project = 'A Guide for CSST DAS Developers'
 copyright = '2022, CSST DAS Team'
 author = 'CSST DAS Team'
 
diff --git a/doc/source/csst_common/csst_common.rst b/doc/source/csst_common/csst_common.rst
index 7ee0313..f6b358d 100644
--- a/doc/source/csst_common/csst_common.rst
+++ b/doc/source/csst_common/csst_common.rst
@@ -105,6 +105,6 @@ We recommend our developers to use the code structure used in the example interf
 e.g., ``process_single_image`` and ``process_multiple_images``.
 The example code is shown below.
 
-.. literalinclude:: ./example_interface.py
+.. literalinclude:: example_interface.py
     :linenos:
     :language: python
diff --git a/doc/source/csst_common/example_interface.py b/doc/source/csst_common/example_interface.py
index 2411d8a..b204abb 100644
--- a/doc/source/csst_common/example_interface.py
+++ b/doc/source/csst_common/example_interface.py
@@ -28,6 +28,7 @@ def check_results(dm: CsstMsDataManager, logger: logging.Logger) -> bool:
     if all(existence):
         return True
     else:
+        logger.warning("Not all processed files are generated!")
         return False
 
 
@@ -114,7 +115,7 @@ def process_multiple_images(
     Examples
     --------
     >>> dm = CsstMsDataManager.quickstart(
-    >>>     ver_sim="C5.2", dir_l1=".", datatype="sls", exposure_id=100)
+    >>>     ver_sim="C5.2", dir_l1="", datatype="sls", exposure_id=100)
     >>> logger = get_logger()
     >>> process_multiple_images(dm, logger)
     """
diff --git a/doc/source/index.rst b/doc/source/index.rst
index f93466b..929057f 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-CSST Pipeline prototype
-=======================
+A Guide for CSST DAS Developers
+===============================
 
 .. meta::
    :description lang=cn: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs.
-- 
GitLab