index.rst

.. csst_proto documentation master file, created by
   sphinx-quickstart on Tue Aug 23 20:39:04 2022.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

A Guide for CSST DAS Developers
===============================

.. meta::
   :description lang=cn: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs.


.. image:: https://readthedocs.org/projects/csst-proto/badge/?version=latest
    :target: https://csst-proto.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status


.. toctree::
   :maxdepth: 2
   :caption: CONTENTS


Hi!
This is an internal guide for CSST DAS developers.
The associated package, `csst_proto`_, is the prototype of CSST L1 pipeline.
The aim of this document is to provide an example of how to build a functional
quality module for CSST DAS pipline.
Here also host the basic standards of CSST DAS pipelines as well as many details.

CSST DAS pipelines are mainly based on `Python`_.
All CSST Python code should be consistent with the PEP 8 style guide.
Developers should follow the standard `Python Packaging User Guide`_ to package
their codes.

.. _Python Packaging User Guide: https://packaging.python.org/en/latest/
.. _Python: https://www.python.org/
.. _csst_proto: https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto


This guide is also highly influenced by the two below.

The guide for astropy-affiliated package development
   https://docs.astropy.org/en/latest/development/docguide.html

The guide for LSST developers
   https://developer.lsst.io/


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: TEAM

   team.rst


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: GUIDES FOR DEVELOPERS

   vcs.rst
   packaging.rst
   codestyle.rst
   unittest.rst
   simulation.rst
   csst_common/csst_common.rst


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: CI / CD

   cicd.rst


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: API

   api/csst_proto.rst