Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Bo Zhang
csst
Commits
297fe499
Commit
297fe499
authored
Mar 02, 2022
by
BO ZHANG
🏀
Browse files
added apidoc
parent
5e3bde33
Changes
5
Show whitespace changes
Inline
Side-by-side
doc/source/api/csst.common.rst
0 → 100644
View file @
297fe499
csst.common.exception
---------------------
.. automodule:: csst.common.exception
:members:
:show-inheritance:
csst.common.data
----------------
.. automodule:: csst.common.data
:members:
:show-inheritance:
csst.common.processors
----------------------
.. automodule:: csst.common.processors
:members:
:show-inheritance:
doc/source/api/csst.msc.rst
0 → 100644
View file @
297fe499
csst.msc.data
-------------
.. automodule:: csst.msc.data
:members:
:show-inheritance:
.. seealso:: :py:mod:`csst.common.data`
csst.msc.instrument
-------------------
.. automodule:: csst.msc.instrument
:members:
:show-inheritance:
doc/source/conf.py
View file @
297fe499
...
...
@@ -10,19 +10,20 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
#
import os
#
import sys
import
os
import
sys
# sys.path.insert(0, os.path.abspath('.'))
import
csst
# -- Project information -----------------------------------------------------
project
=
'csst'
copyright
=
'2022,
csster
'
author
=
'
csster
'
copyright
=
'2022,
CSST team
'
author
=
'
CSST team.
'
# The full version, including alpha/beta/rc tags
release
=
'0.0.1'
release
=
csst
.
__version__
# -- General configuration ---------------------------------------------------
...
...
@@ -31,6 +32,7 @@ release = '0.0.1'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions
=
[
"sphinx.ext.autodoc"
,
]
# Add any paths that contain templates here, relative to this directory.
...
...
doc/source/index.rst
View file @
297fe499
...
...
@@ -3,16 +3,45 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Work with `csst`
======================
****
csst
****
.. image:: https://readthedocs.org/projects/csst/badge/?version=latest
:target: https://csst.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
`csst` is the pipeline package for the **CSST** (Chinese Space Station Telescope).
************
Installation
************
Install using `pip <https://pypi.org/project/matplotlib>`__:
.. code-block:: bash
pip install -U git+git://github.com/csster/csst
.. toctree::
:caption: Examples
:maxdepth: 1
tutorial
.. toctree::
:maxdepth: 2
:caption: API
api/csst.common.rst
api/csst.msc.rst
.. sectionauthor:: Bo Zhang <bozhang@nao.cas.cn>
Indices and tables
==================
...
...
doc/source/tutorial.rst
View file @
297fe499
...
...
@@ -34,4 +34,8 @@ The output:
instrument: MSC
object: 100000279
to be updated ...
Full code is below
.. literalinclude:: ../../examples/example_csstmscdata.py
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