docs

csst_dfs_api/ifs/level1.py

@@ -3,7 +3,7 @@ from ..common.delegate import Delegate
 
 class Level1DataApi(object):
     """
-    Level1 Data Operation Class
+    IFS Level1 Data Operation Class
     """
     def __init__(self):
         self.pymodule = Delegate().load(sub_module = "ifs")
@@ -13,9 +13,9 @@ class Level1DataApi(object):
         ''' retrieve level1 records from database
 
         :param kwargs: Parameter dictionary, key items support:
-            raw_id: [int]
-            data_type: [str]
-            obs_type: [str]
+            raw_id: [int],
+            data_type: [str],
+            obs_type: [str],
             create_time : (start, end),
             qc1_status : [int],
             prc_status : [int],

docs/source/api.rst

+****************************************
+API
+****************************************
+
+.. toctree::
+   :maxdepth: 2
+
+   rst/csst_dfs_api.cpic
+   rst/csst_dfs_api.facility
+   rst/csst_dfs_api.hstdm
+   rst/csst_dfs_api.ifs
+   rst/csst_dfs_api.mci
+   rst/csst_dfs_api.msc
+
+
+

docs/source/changelog.rst

+********************
+Change log
+********************
+
+0.0.1
+-----
+- C3 pipeline
\ No newline at end of file

docs/source/conf.py

@@ -81,7 +81,7 @@ pygments_style = None
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'classic'
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/source/index.rst

-.. CSST DFS API documentation master file, created by
-   sphinx-quickstart on Thu Jun 10 08:55:39 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+****************************************
+Welcome to CSST-DFS-API's documentation!
+****************************************
 
-Welcome to CSST DFS API's documentation!
-========================================
-
-This package provides APIs to access CSST's files and databases.
-
-Installation
-================
-
-This library can be installed with the following command: 
-
-.. code-block:: c
-
-   git clone https://github.com/astronomical-data-processing/csst-dfs-api.git
-   cd csst-dfs-api
-   pip install -r requirements.txt
-   python setup.py install 
-
-* NOTE: This library is heavily under coding, if any bugs occur, firstly you should try to update codes and install again like:
-
-.. code-block:: c
-
-   git pull
-   pip install -r requirements.txt
-   python setup.py install 
-
-APIs
-=====================
 .. toctree::
-   :maxdepth: 4
-
-   rst/modules
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction
+   installation
+   usage
+   api
+   changelog
 
 Indices and tables
 ==================

docs/source/installation.rst

+********************
+Installation
+********************
+
+Installation
+==============
+
+This library can be installed with the following command: 
+
+.. code-block:: console
+
+   $ git clone https://github.com/astronomical-data-processing/csst-dfs-api.git
+   $ cd csst-dfs-api
+   $ pip install -r requirements.txt
+   $ python setup.py install 
+
+Upgrade
+==============
+
+* NOTE: This library is heavily under coding, if any bugs occur, firstly you should try to update codes and install again like:
+
+.. code-block:: console
+
+   $ git pull
+   $ pip install -r requirements.txt
+   $ python setup.py install 
+
+This is the recommended installation method and will install the latest release.

docs/source/introduction.rst

+************
+Introduction
+************
+
+This package provides APIs to access CSST's files and databases.
\ No newline at end of file

docs/source/usage.rst

+********************
+Usage
+********************
+
+Common
+==============
+
+
+Facility
+==============
+
+
+MSC
+==============
+
+
+IFS
+==============