Commit f8deca3d authored by M. Huang's avatar M. Huang
Browse files

v1.0

parent 707e800e
...@@ -17,19 +17,19 @@ To install (It is a good idea to add ``--user`` at the end or to use a virtualen ...@@ -17,19 +17,19 @@ To install (It is a good idea to add ``--user`` at the end or to use a virtualen
.. code-block:: shell .. code-block:: shell
pip3 install git+http://mercury.bao.ac.cn:9006/mh/fdi.git python3 -m pip install http://mercury.bao.ac.cn:9006/mh/fdi/-/archive/v1.0/fdi-v1.0rc.tar.gz
If you want to install the ``develop`` branch: If you want to install the ``develop`` branch:
.. code-block:: shell .. code-block:: shell
pip3 install git+http://mercury.bao.ac.cn:9006/mh/fdi.git@develop python3 -m pip install git+http://mercury.bao.ac.cn:9006/mh/fdi.git@develop
To uninstall: To uninstall:
.. code-block:: shell .. code-block:: shell
pip3 uninstall fdi python3 -m pip uninstall fdi
For Developers and Admins For Developers and Admins
...@@ -43,7 +43,7 @@ To install (It is a good idea to add ``--user`` at the end or to use a virtualen ...@@ -43,7 +43,7 @@ To install (It is a good idea to add ``--user`` at the end or to use a virtualen
cd $FDIINSTDIR cd $FDIINSTDIR
git clone ssh://git@mercury.bao.ac.cn:9005/mh/fdi.git@develop git clone ssh://git@mercury.bao.ac.cn:9005/mh/fdi.git@develop
cd fdi cd fdi
pip3 install -e .[DEV] python3 -m pip install -e .[DEV]
If you want to install the ``master`` branch, remove the ``@develop`` part above.. If you want to install the ``master`` branch, remove the ``@develop`` part above..
...@@ -91,7 +91,7 @@ install the dependencies: ...@@ -91,7 +91,7 @@ install the dependencies:
.. code-block:: shell .. code-block:: shell
pip3 install -e .[SERV] python3 -m pip install -e .[SERV]
make installpns make installpns
To test your ``pns`` servers installation, in one window, run: To test your ``pns`` servers installation, in one window, run:
......
...@@ -29,7 +29,12 @@ copyright = '2019 - %d Maohai Huang, NAOC, ESA' % year ...@@ -29,7 +29,12 @@ copyright = '2019 - %d Maohai Huang, NAOC, ESA' % year
author = 'Maohai Huang' author = 'Maohai Huang'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = 'v1.0rc6' # Version info -- read without importing
# https://github.com/aio-libs/aiohttp-theme/blob/master/setup.py
_locals = {}
with open('../../fdi/_version.py') as fp:
exec(fp.read(), None, _locals)
release = _locals['__version__']
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
......
...@@ -60,7 +60,6 @@ API Document ...@@ -60,7 +60,6 @@ API Document
:caption: API: :caption: API:
api/api api/api
fdi/fdi
.. image:: _static/packages_all.png .. image:: _static/packages_all.png
......
...@@ -7,7 +7,7 @@ Installation and Notes for Developers ...@@ -7,7 +7,7 @@ Installation and Notes for Developers
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
If the contents do now show below, read them in :doc:`../../../README` If the contents do not show below, read them in :doc:`../../../README`
.. include:: ../../../README.rst .. include:: ../../../README.rst
:start-after: Install/Uninstall :start-after: Install/Uninstall
......
__version_info__ = (1, 0, 'pre') __version_info__ = (1, 0,)
__version__ = '.'.join(map(str, __version_info__)) __version__ = '.'.join(map(str, __version_info__))
...@@ -70,7 +70,7 @@ def lls(s, length=80): ...@@ -70,7 +70,7 @@ def lls(s, length=80):
def wls(s, width=15): def wls(s, width=15):
""" widthth-limited string. """ widthth-limited string.
width: if > 0 Returns the str with '\n' inserted every width chars. Or else return s. width: if > 0 returns the str with '\n' inserted every width chars. Or else return ``s``. Default is 15.
""" """
if width <= 0: if width <= 0:
...@@ -137,10 +137,10 @@ def mstr(obj, level=0, excpt=None, indent=4, depth=0, **kwds): ...@@ -137,10 +137,10 @@ def mstr(obj, level=0, excpt=None, indent=4, depth=0, **kwds):
def binhexstring(val, typ_, width=0, v=None, p=None): def binhexstring(val, typ_, width=0, v=None, p=None):
""" returns val in binar, hex, or string according to typ_ """ returns val in binar, hex, or string according to typ_.
val; list of valid descriptor entries. val; list of valid descriptor entries.
typ_: parameter type typ_: parameter type in ``DataTypes``.
""" """
if typ_ == 'hex': if typ_ == 'hex':
func = hex func = hex
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment