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
csst-pipeline
csst_proto
Commits
2b1f55ee
Commit
2b1f55ee
authored
Oct 09, 2022
by
BO ZHANG
🏀
Browse files
tweaks and added copy button
parent
dce50605
Pipeline
#196
passed with stages
in 14 seconds
Changes
4
Pipelines
1
Show whitespace changes
Inline
Side-by-side
doc/latexpdf.sh
View file @
2b1f55ee
make latexpdf
LATEXMKOPTS
=
"-silent"
make latexpdf
LATEXMKOPTS
=
"-silent"
cd
build/latex
||
exit
cd
build/latex
||
exit
latexmk
-pdf
-dvi-
-ps-
-silent
'guide
s
forcsstdasdevelopers.tex'
latexmk
-pdf
-dvi-
-ps-
-silent
'
a
guideforcsstdasdevelopers.tex'
cd
../..
cd
../..
open ./build/latex/guidesforcsstdasdevelopers.pdf
open ./build/latex/aguideforcsstdasdevelopers.pdf
\ No newline at end of file
\ No newline at end of file
doc/source/conf.py
View file @
2b1f55ee
...
@@ -10,9 +10,10 @@
...
@@ -10,9 +10,10 @@
# add these directories to sys.path here. If the directory is relative to the
# 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.
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
#
# import os
import
os
# import sys
import
sys
# sys.path.insert(0, os.path.abspath('.'))
# . = /doc/source
sys
.
path
.
insert
(
0
,
os
.
path
.
abspath
(
'./csst_common'
))
# -- Project information -----------------------------------------------------
# -- Project information -----------------------------------------------------
...
@@ -31,6 +32,7 @@ release = '0.0.1alpha'
...
@@ -31,6 +32,7 @@ release = '0.0.1alpha'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
# ones.
extensions
=
[
"recommonmark"
,
extensions
=
[
"recommonmark"
,
"sphinx_copybutton"
,
"sphinx.ext.autodoc"
,
"sphinx.ext.autodoc"
,
"sphinx.ext.napoleon"
,
"sphinx.ext.napoleon"
,
"sphinx.ext.viewcode"
,
"sphinx.ext.viewcode"
,
...
...
doc/source/csst_common/csst_common.rst
View file @
2b1f55ee
...
@@ -106,6 +106,18 @@ We recommend our developers to use the code structure used in the example interf
...
@@ -106,6 +106,18 @@ We recommend our developers to use the code structure used in the example interf
e.g., ``process_single_image`` and ``process_multiple_images``.
e.g., ``process_single_image`` and ``process_multiple_images``.
The example code is shown below.
The example code is shown below.
Source code
^^^^^^^^^^^
.. literalinclude:: example_interface.py
.. literalinclude:: example_interface.py
:caption: ``example_interface.py``
:emphasize-lines: 36-40,81-82,85-86,89-90,94-97,143-144,147,150-151,154-155
:linenos:
:linenos:
:language: python
:language: python
Rendered ``docstring``
^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: example_interface
:members:
setup.py
View file @
2b1f55ee
...
@@ -7,7 +7,7 @@ with open("README.md", "r") as fh:
...
@@ -7,7 +7,7 @@ with open("README.md", "r") as fh:
setuptools
.
setup
(
setuptools
.
setup
(
name
=
'csst_proto'
,
name
=
'csst_proto'
,
version
=
csst_proto
.
__version__
,
version
=
csst_proto
.
__version__
,
author
=
'
CSST Team
'
,
author
=
'
Bo Zhang
'
,
author_email
=
'bozhang@nao.cas.cn'
,
author_email
=
'bozhang@nao.cas.cn'
,
description
=
'The CSST L1 pipeline - prototype'
,
# short description
description
=
'The CSST L1 pipeline - prototype'
,
# short description
long_description
=
long_description
,
long_description
=
long_description
,
...
...
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