Commit 2b1f55ee authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

tweaks and added copy button

parent dce50605

doc/latexpdf.sh

+2 −2
Original line number Diff line number Diff line 
make latexpdf LATEXMKOPTS="-silent"

cd build/latex || exit

latexmk -pdf -dvi- -ps- -silent 'guidesforcsstdasdevelopers.tex'

latexmk -pdf -dvi- -ps- -silent 'aguideforcsstdasdevelopers.tex'

cd ../..

open ./build/latex/guidesforcsstdasdevelopers.pdf
 
 No newline at end of file
 
open ./build/latex/aguideforcsstdasdevelopers.pdf
 
 No newline at end of file

doc/source/conf.py

+5 −3
Original line number Diff line number Diff line
@@ -10,9 +10,10 @@ 
# 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

# sys.path.insert(0, os.path.abspath('.'))

import os

import sys

# . = /doc/source

sys.path.insert(0, os.path.abspath('./csst_common'))





# -- Project information -----------------------------------------------------
@@ -31,6 +32,7 @@ release = '0.0.1alpha' 
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom

# ones.

extensions = ["recommonmark",

              "sphinx_copybutton",

              "sphinx.ext.autodoc",

              "sphinx.ext.napoleon",

              "sphinx.ext.viewcode",

doc/source/csst_common/csst_common.rst

+12 −0
Original line number Diff line number Diff line
@@ -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``.

The example code is shown below.



Source code

^^^^^^^^^^^



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

    :language: python





Rendered ``docstring``

^^^^^^^^^^^^^^^^^^^^^^



.. automodule:: example_interface

    :members:

setup.py

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ with open("README.md", "r") as fh: 
setuptools.setup(

    name='csst_proto',

    version=csst_proto.__version__,

    author='CSST Team',

    author='Bo Zhang',

    author_email='bozhang@nao.cas.cn',

    description='The CSST L1 pipeline - prototype',  # short description

    long_description=long_description,