minor changes

doc/source/cicd.rst

@@ -114,3 +114,15 @@ The Numpy style docstring check is only for the packages listed below.
 - csst_ms_mbi_photometry
 
 We welcome other packages participate in.
+
+
+Using ``Jenkins``
+-----------------
+
+... how to use jenkins
+
+
+Docker and Kubernetes
+---------------------
+
+to be updated

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'
 

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

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)
     """

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.