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.

CSST pipeline prototype
=======================

.. 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::
   :hidden:
   :maxdepth: 1
   :caption: CONTENTS

Hello!
Welcome to `csst_proto`_ -- the prototype of CSST L1 pipeline.

The aim of this website is to provide an example of how to write a functional
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`_.
Developers should follow the standard `Python Packaging User Guide`_ to package
their algorithms.

.. _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

*Dress for the job you want, not the one you have.*
A good code repository should
- Use version control (e.g., git)
- Use unit tests
- Have good documentation
- Use good structure

Although it might be difficult in practice, it should always be the ultimate goal
of an excellent programmer.

Last but not least, two very useful websites are listed below for reference.

   - 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: CODE STYLE GUIDES

   git.rst
   codestyle.rst
   sphinxdoc.rst


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

   cicd.rst
   unittest.rst


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

   api/csst_proto.rst