Skip to content
GitLab
Explore
Projects
Groups
Snippets
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
csst-pipeline
csst_proto
Commits
10399bf2
Commit
10399bf2
authored
2 years ago
by
BO ZHANG
Browse files
Options
Download
Email Patches
Plain Diff
tweaks
parent
ab615d03
dev
main
Pipeline
#189
passed with stages
in 13 seconds
Changes
3
Pipelines
1
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
doc/source/api/csst_proto.rst
+3
-0
doc/source/api/csst_proto.rst
doc/source/git.rst
+0
-32
doc/source/git.rst
doc/source/sphinxdoc.rst
+0
-8
doc/source/sphinxdoc.rst
with
3 additions
and
40 deletions
+3
-40
doc/source/api/csst_proto.rst
+
3
-
0
View file @
10399bf2
API
===
In this chapter, we show what the rendered Numpy-style docstring looks like
in sphinx documentation.
.. automodule:: csst_proto.top_level_interface
:noindex:
:members:
...
...
This diff is collapsed.
Click to expand it.
doc/source/git.rst
deleted
100644 → 0
+
0
-
32
View file @
ab615d03
Version Control
===============
A functional quality software needs a version control system,
which provides several advantages.
1. Record versions
so that you can rollback the software to any history version.
2. Collaboration between developers
so that multiple developers can work simultaneously to enhance efficiency.
3. Keep multiple braches
so that software can be developed in a separate branch
and it does not affect the stable (released) version.
4. Code safety
the approve-merge mechanism, etc.
`git`
-----
`git` is probably the most widely used version control system presently.
- official website: https://git-scm.com/
- **Pro Git** (2nd Ed.): https://git-scm.com/book/en/v2
CSST DAS GitLab
---------------
CSST DAS uses a self-managed `gitlab` instance to host data processing pipelines at
- https://csst-tb.bao.ac.cn/code
The Level 1 pipeline is host in `csst-l1` group:
- https://csst-tb.bao.ac.cn/code/csst-l1
This diff is collapsed.
Click to expand it.
doc/source/sphinxdoc.rst
deleted
100644 → 0
+
0
-
8
View file @
ab615d03
Sphinx-based documentation
==========================
The sphinx homepage:
- https://www.sphinx-doc.org/en/master/index.html
A tutorial on how to write restructured text (.rst) files:
- https://docutils.sourceforge.io/rst.html
This diff is collapsed.
Click to expand it.
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment
Menu
Explore
Projects
Groups
Snippets