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: csst_proto

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

欢迎大家来到 `csst_proto` 的文档，这里是CSST一级流水线原型的文档。

`csst_proto` 是一个基于 `Python` 的程序包，目的是为一级流水线功能模块开发提供打包/封装的参考格式。
程序源码以及文档的源码都可以在CSST Gitlab中找到: https://csst-tb.bao.ac.cn/code/csst-l1/csst_proto 。

引用一句英语谚语："Dress for the job you want, not the one you have."
一个优秀的程序库（repository）应该有许多理想的特征，包含但不限于：

- Use version control （使用版本控制，比如 `git`）
- Use tests （测试/单元测试）
- Have good documentation （有好的文档/注释）
- Use good structure （有好的结构）

尽管要在一个大的project中保持好的结构可能非常难，但这一定是优秀开发者的最求的目标。


这里的主要内容包括

- 版本控制 (version control)
   - how to use `git`
- 代码风格 (Code style)
   - PEP8 for Python
   - PEP7 for C
   - Numpydoc
- 单元测试 (unit test)
   - `unittest`
   - `doctest`
   - gitlab CI/CD pipeline
- 文件结构 (file structures)
   - CSST一级流水线功能模块命名
   -
- 开发时间线 (timeline for CSST developers)
   - C6
   - C7


最后放一个值得 CSST 团队学习的网站

   - LSST团队的内部开发指引：https://developer.lsst.io/

希望这个网站对大家的开发有帮助！


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: version control

   git.rst


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: code style

   codestyle.rst
   sphinxdoc.rst


.. toctree::
   :hidden:
   :maxdepth: 2
   :caption: unittest

   unittest.rst


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

   api/csst_proto.rst