update api doc

doc/source/conf.py

@@ -0,0 +1,188 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# 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('../..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'pyModeS'
+copyright = '2019, Junzi Sun'
+author = 'Junzi Sun'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages',
+    'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+# html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'pyModeSdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'pyModeS.tex', 'pyModeS Documentation',
+     'Junzi Sun', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'pymodes', 'pyModeS Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'pyModeS', 'pyModeS Documentation',
+     author, 'pyModeS', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

doc/source/index.rst

@@ -0,0 +1,30 @@
+.. pyModeS documentation master file, created by
+   sphinx-quickstart on Mon Apr  1 13:13:10 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to pyModeS documentation!
+===================================
+
+The source code can be found at: https://github.com/junzis/pyModeS
+
+.. toctree::
+   :maxdepth: 3
+
+   pyModeS.decoder
+   pyModeS.streamer
+   pyModeS.extra
+
+
+----
+
+.. include:: ../../README.rst
+
+----
+
+Indices and tables
+**********************
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/source/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

doc/source/modules.rst

@@ -0,0 +1,7 @@
+pyModeS
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   pyModeS

doc/source/pyModeS.decoder.acas.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.acas module
+===========================
+
+.. automodule:: pyModeS.decoder.acas
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.adsb.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.adsb module
+===========================
+
+.. automodule:: pyModeS.decoder.adsb
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.allcall.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.allcall module
+==============================
+
+.. automodule:: pyModeS.decoder.allcall
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds05.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds05 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds05
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds06.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds06 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds06
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds08.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds08 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds08
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds09.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds09 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds09
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds10.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds10 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds10
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds17.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds17 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds17
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds20.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds20 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds20
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds30.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds30 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds30
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds40.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds40 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds40
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds44.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds44 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds44
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds50.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds50 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds50
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds53.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds53 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds53
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.bds60.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.bds.bds60 module
+================================
+
+.. automodule:: pyModeS.decoder.bds.bds60
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.bds.rst

@@ -0,0 +1,27 @@
+pyModeS.decoder.bds package
+===========================
+
+.. automodule:: pyModeS.decoder.bds
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   pyModeS.decoder.bds.bds05
+   pyModeS.decoder.bds.bds06
+   pyModeS.decoder.bds.bds08
+   pyModeS.decoder.bds.bds09
+   pyModeS.decoder.bds.bds10
+   pyModeS.decoder.bds.bds17
+   pyModeS.decoder.bds.bds20
+   pyModeS.decoder.bds.bds30
+   pyModeS.decoder.bds.bds40
+   pyModeS.decoder.bds.bds44
+   pyModeS.decoder.bds.bds50
+   pyModeS.decoder.bds.bds53
+   pyModeS.decoder.bds.bds60
+

doc/source/pyModeS.decoder.commb.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.commb module
+============================
+
+.. automodule:: pyModeS.decoder.commb
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.common.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.common module
+=============================
+
+.. automodule:: pyModeS.decoder.common
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.ehs.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.ehs module
+==========================
+
+.. automodule:: pyModeS.decoder.ehs
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.els.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.els module
+==========================
+
+.. automodule:: pyModeS.decoder.els
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.rst

@@ -0,0 +1,30 @@
+pyModeS.decoder package
+=======================
+
+.. automodule:: pyModeS.decoder
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    pyModeS.decoder.bds
+
+Submodules
+----------
+
+.. toctree::
+
+   pyModeS.decoder.acas
+   pyModeS.decoder.adsb
+   pyModeS.decoder.allcall
+   pyModeS.decoder.commb
+   pyModeS.decoder.common
+   pyModeS.decoder.ehs
+   pyModeS.decoder.els
+   pyModeS.decoder.surv
+   pyModeS.decoder.uncertainty
+

doc/source/pyModeS.decoder.surv.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.surv module
+===========================
+
+.. automodule:: pyModeS.decoder.surv
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.decoder.uncertainty.rst

@@ -0,0 +1,7 @@
+pyModeS.decoder.uncertainty module
+==================================
+
+.. automodule:: pyModeS.decoder.uncertainty
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.extra.aero.rst

@@ -0,0 +1,7 @@
+pyModeS.extra.aero module
+=========================
+
+.. automodule:: pyModeS.extra.aero
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.extra.rst

@@ -0,0 +1,16 @@
+pyModeS.extra package
+=====================
+
+.. automodule:: pyModeS.extra
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   pyModeS.extra.aero
+   pyModeS.extra.tcpclient
+

doc/source/pyModeS.extra.tcpclient.rst

@@ -0,0 +1,7 @@
+pyModeS.extra.tcpclient module
+==============================
+
+.. automodule:: pyModeS.extra.tcpclient
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.rst

@@ -0,0 +1,17 @@
+pyModeS package
+===============
+
+.. automodule:: pyModeS
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+
+    pyModeS.decoder
+    pyModeS.extra
+    pyModeS.streamer
+

doc/source/pyModeS.streamer.rst

@@ -0,0 +1,16 @@
+pyModeS.streamer package
+========================
+
+.. automodule:: pyModeS.streamer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   pyModeS.streamer.screen
+   pyModeS.streamer.stream
+

doc/source/pyModeS.streamer.screen.rst

@@ -0,0 +1,7 @@
+pyModeS.streamer.screen module
+==============================
+
+.. automodule:: pyModeS.streamer.screen
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/source/pyModeS.streamer.stream.rst

@@ -0,0 +1,7 @@
+pyModeS.streamer.stream module
+==============================
+
+.. automodule:: pyModeS.streamer.stream
+    :members:
+    :undoc-members:
+    :show-inheritance: