From 11a560dbb53e66518cfccb325b466d1ee9c9aad0 Mon Sep 17 00:00:00 2001 From: Junzi Sun Date: Mon, 4 May 2020 01:07:02 +0200 Subject: [PATCH] update API doc --- doc/Makefile | 2 +- doc/source/conf.py | 62 ++++++++++++---------- doc/source/index.rst | 46 ++++++++++++++-- doc/source/make.bat | 35 ------------ doc/source/pyModeS.c_common.rst | 7 +++ doc/source/pyModeS.common.rst | 7 +++ doc/source/pyModeS.decoder.acas.rst | 6 +-- doc/source/pyModeS.decoder.adsb.rst | 6 +-- doc/source/pyModeS.decoder.allcall.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds05.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds06.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds08.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds09.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds10.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds17.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds20.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds30.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds40.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds44.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds45.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds50.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds53.rst | 6 +-- doc/source/pyModeS.decoder.bds.bds60.rst | 6 +-- doc/source/pyModeS.decoder.bds.rst | 8 +-- doc/source/pyModeS.decoder.commb.rst | 6 +-- doc/source/pyModeS.decoder.common.rst | 7 --- doc/source/pyModeS.decoder.ehs.rst | 7 --- doc/source/pyModeS.decoder.els.rst | 7 --- doc/source/pyModeS.decoder.rst | 15 +++--- doc/source/pyModeS.decoder.surv.rst | 6 +-- doc/source/pyModeS.decoder.uncertainty.rst | 6 +-- doc/source/pyModeS.decoder.uplink.rst | 7 +++ doc/source/pyModeS.extra.aero.rst | 7 --- doc/source/pyModeS.extra.rst | 16 ------ doc/source/pyModeS.extra.tcpclient.rst | 7 --- doc/source/pyModeS.rst | 19 ++++--- doc/source/pyModeS.streamer.rst | 16 ------ doc/source/pyModeS.streamer.screen.rst | 7 --- doc/source/pyModeS.streamer.stream.rst | 7 --- doc/warnings | 0 40 files changed, 181 insertions(+), 228 deletions(-) delete mode 100644 doc/source/make.bat create mode 100644 doc/source/pyModeS.c_common.rst create mode 100644 doc/source/pyModeS.common.rst delete mode 100644 doc/source/pyModeS.decoder.common.rst delete mode 100644 doc/source/pyModeS.decoder.ehs.rst delete mode 100644 doc/source/pyModeS.decoder.els.rst create mode 100644 doc/source/pyModeS.decoder.uplink.rst delete mode 100644 doc/source/pyModeS.extra.aero.rst delete mode 100644 doc/source/pyModeS.extra.rst delete mode 100644 doc/source/pyModeS.extra.tcpclient.rst delete mode 100644 doc/source/pyModeS.streamer.rst delete mode 100644 doc/source/pyModeS.streamer.screen.rst delete mode 100644 doc/source/pyModeS.streamer.stream.rst create mode 100644 doc/warnings diff --git a/doc/Makefile b/doc/Makefile index 286116e..4a540ca 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -17,5 +17,5 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile rm -f source/pyModeS*.rst source/modules.rst - sphinx-apidoc -f -e -M -o source/ ../pyModeS + sphinx-apidoc -f -e -M -o source/ ../pyModeS ../pyModeS/decoder/ehs.py ../pyModeS/decoder/els.py ../pyModeS/streamer ../pyModeS/extra @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/doc/source/conf.py b/doc/source/conf.py index eaf18de..cd0d080 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -14,19 +14,20 @@ # import os import sys -sys.path.insert(0, os.path.abspath('../..')) + +sys.path.insert(0, os.path.abspath("../..")) # -- Project information ----------------------------------------------------- -project = 'pyModeS' -copyright = '2019, Junzi Sun' -author = 'Junzi Sun' +project = "pyModeS" +copyright = "2019, Junzi Sun" +author = "Junzi Sun" # The short X.Y version -version = '' +version = "" # The full version, including alpha/beta/rc tags -release = '' +release = "" # -- General configuration --------------------------------------------------- @@ -39,13 +40,13 @@ release = '' # 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', + "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. @@ -55,10 +56,10 @@ extensions = [ # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -82,6 +83,10 @@ pygments_style = None # a list of builtin themes. # # html_theme = 'alabaster' +html_theme = "neo_rtd_theme" +import sphinx_theme + +html_theme_path = [sphinx_theme.get_html_theme_path()] # 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 @@ -108,7 +113,7 @@ pygments_style = None # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. -htmlhelp_basename = 'pyModeSdoc' +htmlhelp_basename = "pyModeSdoc" # -- Options for LaTeX output ------------------------------------------------ @@ -117,15 +122,12 @@ 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', @@ -135,8 +137,7 @@ latex_elements = { # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'pyModeS.tex', 'pyModeS Documentation', - 'Junzi Sun', 'manual'), + (master_doc, "pyModeS.tex", "pyModeS Documentation", "Junzi Sun", "manual") ] @@ -144,10 +145,7 @@ latex_documents = [ # 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) -] +man_pages = [(master_doc, "pymodes", "pyModeS Documentation", [author], 1)] # -- Options for Texinfo output ---------------------------------------------- @@ -156,9 +154,15 @@ man_pages = [ # (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'), + ( + master_doc, + "pyModeS", + "pyModeS Documentation", + author, + "pyModeS", + "One line description of project.", + "Miscellaneous", + ) ] @@ -177,7 +181,7 @@ epub_title = project # epub_uid = '' # A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] +epub_exclude_files = ["search.html"] # -- Extension configuration ------------------------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 40de2fc..d9a8551 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,11 +9,49 @@ Welcome to pyModeS documentation! The source code can be found at: https://github.com/junzis/pyModeS .. toctree:: - :maxdepth: 3 + :caption: Core modules + :maxdepth: 2 + + pyModeS.decoder.adsb + pyModeS.decoder.commb + + +.. toctree:: + :caption: ADS-B messages + :maxdepth: 2 + + pyModeS.decoder.bds.bds05 + pyModeS.decoder.bds.bds06 + pyModeS.decoder.bds.bds08 + pyModeS.decoder.bds.bds09 + + +.. toctree:: + :caption: ELS - elementary surveillance + :maxdepth: 2 + + pyModeS.decoder.bds.bds10 + pyModeS.decoder.bds.bds17 + pyModeS.decoder.bds.bds20 + pyModeS.decoder.bds.bds30 + + +.. toctree:: + :caption: EHS - enhanced surveillance + :maxdepth: 2 + + pyModeS.decoder.bds.bds40 + pyModeS.decoder.bds.bds50 + pyModeS.decoder.bds.bds60 + + +.. toctree:: + :caption: MRAR / MHR + :maxdepth: 2 + + pyModeS.decoder.bds.bds44 + pyModeS.decoder.bds.bds45 - pyModeS.decoder - pyModeS.streamer - pyModeS.extra ---- diff --git a/doc/source/make.bat b/doc/source/make.bat deleted file mode 100644 index 27f573b..0000000 --- a/doc/source/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@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 diff --git a/doc/source/pyModeS.c_common.rst b/doc/source/pyModeS.c_common.rst new file mode 100644 index 0000000..e01a891 --- /dev/null +++ b/doc/source/pyModeS.c_common.rst @@ -0,0 +1,7 @@ +pyModeS.c\_common module +======================== + +.. automodule:: pyModeS.c_common + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.common.rst b/doc/source/pyModeS.common.rst new file mode 100644 index 0000000..12506a9 --- /dev/null +++ b/doc/source/pyModeS.common.rst @@ -0,0 +1,7 @@ +pyModeS.common module +===================== + +.. automodule:: pyModeS.common + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.acas.rst b/doc/source/pyModeS.decoder.acas.rst index c02eb92..4a6ec24 100644 --- a/doc/source/pyModeS.decoder.acas.rst +++ b/doc/source/pyModeS.decoder.acas.rst @@ -2,6 +2,6 @@ pyModeS.decoder.acas module =========================== .. automodule:: pyModeS.decoder.acas - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.adsb.rst b/doc/source/pyModeS.decoder.adsb.rst index 5f97d15..69e4d36 100644 --- a/doc/source/pyModeS.decoder.adsb.rst +++ b/doc/source/pyModeS.decoder.adsb.rst @@ -2,6 +2,6 @@ pyModeS.decoder.adsb module =========================== .. automodule:: pyModeS.decoder.adsb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.allcall.rst b/doc/source/pyModeS.decoder.allcall.rst index a538c03..9cd724f 100644 --- a/doc/source/pyModeS.decoder.allcall.rst +++ b/doc/source/pyModeS.decoder.allcall.rst @@ -2,6 +2,6 @@ pyModeS.decoder.allcall module ============================== .. automodule:: pyModeS.decoder.allcall - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds05.rst b/doc/source/pyModeS.decoder.bds.bds05.rst index f48d89e..9a83237 100644 --- a/doc/source/pyModeS.decoder.bds.bds05.rst +++ b/doc/source/pyModeS.decoder.bds.bds05.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds05 module ================================ .. automodule:: pyModeS.decoder.bds.bds05 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds06.rst b/doc/source/pyModeS.decoder.bds.bds06.rst index 7cbff9a..1813fba 100644 --- a/doc/source/pyModeS.decoder.bds.bds06.rst +++ b/doc/source/pyModeS.decoder.bds.bds06.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds06 module ================================ .. automodule:: pyModeS.decoder.bds.bds06 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds08.rst b/doc/source/pyModeS.decoder.bds.bds08.rst index 1a84527..e3a71ae 100644 --- a/doc/source/pyModeS.decoder.bds.bds08.rst +++ b/doc/source/pyModeS.decoder.bds.bds08.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds08 module ================================ .. automodule:: pyModeS.decoder.bds.bds08 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds09.rst b/doc/source/pyModeS.decoder.bds.bds09.rst index 2041924..9ff72f6 100644 --- a/doc/source/pyModeS.decoder.bds.bds09.rst +++ b/doc/source/pyModeS.decoder.bds.bds09.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds09 module ================================ .. automodule:: pyModeS.decoder.bds.bds09 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds10.rst b/doc/source/pyModeS.decoder.bds.bds10.rst index f3e39bf..b795759 100644 --- a/doc/source/pyModeS.decoder.bds.bds10.rst +++ b/doc/source/pyModeS.decoder.bds.bds10.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds10 module ================================ .. automodule:: pyModeS.decoder.bds.bds10 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds17.rst b/doc/source/pyModeS.decoder.bds.bds17.rst index a4fbcbd..654c662 100644 --- a/doc/source/pyModeS.decoder.bds.bds17.rst +++ b/doc/source/pyModeS.decoder.bds.bds17.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds17 module ================================ .. automodule:: pyModeS.decoder.bds.bds17 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds20.rst b/doc/source/pyModeS.decoder.bds.bds20.rst index dbe9753..8af6608 100644 --- a/doc/source/pyModeS.decoder.bds.bds20.rst +++ b/doc/source/pyModeS.decoder.bds.bds20.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds20 module ================================ .. automodule:: pyModeS.decoder.bds.bds20 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds30.rst b/doc/source/pyModeS.decoder.bds.bds30.rst index 714376d..8ad11bd 100644 --- a/doc/source/pyModeS.decoder.bds.bds30.rst +++ b/doc/source/pyModeS.decoder.bds.bds30.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds30 module ================================ .. automodule:: pyModeS.decoder.bds.bds30 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds40.rst b/doc/source/pyModeS.decoder.bds.bds40.rst index 1b907f1..6cb9409 100644 --- a/doc/source/pyModeS.decoder.bds.bds40.rst +++ b/doc/source/pyModeS.decoder.bds.bds40.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds40 module ================================ .. automodule:: pyModeS.decoder.bds.bds40 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds44.rst b/doc/source/pyModeS.decoder.bds.bds44.rst index daed300..9d5b2d1 100644 --- a/doc/source/pyModeS.decoder.bds.bds44.rst +++ b/doc/source/pyModeS.decoder.bds.bds44.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds44 module ================================ .. automodule:: pyModeS.decoder.bds.bds44 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds45.rst b/doc/source/pyModeS.decoder.bds.bds45.rst index b4494bb..758ab2e 100644 --- a/doc/source/pyModeS.decoder.bds.bds45.rst +++ b/doc/source/pyModeS.decoder.bds.bds45.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds45 module ================================ .. automodule:: pyModeS.decoder.bds.bds45 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds50.rst b/doc/source/pyModeS.decoder.bds.bds50.rst index 85198da..7c89442 100644 --- a/doc/source/pyModeS.decoder.bds.bds50.rst +++ b/doc/source/pyModeS.decoder.bds.bds50.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds50 module ================================ .. automodule:: pyModeS.decoder.bds.bds50 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds53.rst b/doc/source/pyModeS.decoder.bds.bds53.rst index ac365ec..ebe9247 100644 --- a/doc/source/pyModeS.decoder.bds.bds53.rst +++ b/doc/source/pyModeS.decoder.bds.bds53.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds53 module ================================ .. automodule:: pyModeS.decoder.bds.bds53 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.bds60.rst b/doc/source/pyModeS.decoder.bds.bds60.rst index df83367..6c38b59 100644 --- a/doc/source/pyModeS.decoder.bds.bds60.rst +++ b/doc/source/pyModeS.decoder.bds.bds60.rst @@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds60 module ================================ .. automodule:: pyModeS.decoder.bds.bds60 - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.bds.rst b/doc/source/pyModeS.decoder.bds.rst index 78ad76b..ace6958 100644 --- a/doc/source/pyModeS.decoder.bds.rst +++ b/doc/source/pyModeS.decoder.bds.rst @@ -2,14 +2,15 @@ pyModeS.decoder.bds package =========================== .. automodule:: pyModeS.decoder.bds - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: Submodules ---------- .. toctree:: + :maxdepth: 4 pyModeS.decoder.bds.bds05 pyModeS.decoder.bds.bds06 @@ -25,4 +26,3 @@ Submodules pyModeS.decoder.bds.bds50 pyModeS.decoder.bds.bds53 pyModeS.decoder.bds.bds60 - diff --git a/doc/source/pyModeS.decoder.commb.rst b/doc/source/pyModeS.decoder.commb.rst index a5b228c..ad23b9f 100644 --- a/doc/source/pyModeS.decoder.commb.rst +++ b/doc/source/pyModeS.decoder.commb.rst @@ -2,6 +2,6 @@ pyModeS.decoder.commb module ============================ .. automodule:: pyModeS.decoder.commb - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.common.rst b/doc/source/pyModeS.decoder.common.rst deleted file mode 100644 index ce3afc2..0000000 --- a/doc/source/pyModeS.decoder.common.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyModeS.decoder.common module -============================= - -.. automodule:: pyModeS.decoder.common - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/pyModeS.decoder.ehs.rst b/doc/source/pyModeS.decoder.ehs.rst deleted file mode 100644 index 5f1ae62..0000000 --- a/doc/source/pyModeS.decoder.ehs.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyModeS.decoder.ehs module -========================== - -.. automodule:: pyModeS.decoder.ehs - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/pyModeS.decoder.els.rst b/doc/source/pyModeS.decoder.els.rst deleted file mode 100644 index 81b7c16..0000000 --- a/doc/source/pyModeS.decoder.els.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyModeS.decoder.els module -========================== - -.. automodule:: pyModeS.decoder.els - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/pyModeS.decoder.rst b/doc/source/pyModeS.decoder.rst index a04bff2..21b8670 100644 --- a/doc/source/pyModeS.decoder.rst +++ b/doc/source/pyModeS.decoder.rst @@ -2,29 +2,28 @@ pyModeS.decoder package ======================= .. automodule:: pyModeS.decoder - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: Subpackages ----------- .. toctree:: + :maxdepth: 4 - pyModeS.decoder.bds + pyModeS.decoder.bds Submodules ---------- .. toctree:: + :maxdepth: 4 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 - + pyModeS.decoder.uplink diff --git a/doc/source/pyModeS.decoder.surv.rst b/doc/source/pyModeS.decoder.surv.rst index b60a658..f1489be 100644 --- a/doc/source/pyModeS.decoder.surv.rst +++ b/doc/source/pyModeS.decoder.surv.rst @@ -2,6 +2,6 @@ pyModeS.decoder.surv module =========================== .. automodule:: pyModeS.decoder.surv - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.uncertainty.rst b/doc/source/pyModeS.decoder.uncertainty.rst index 50a7878..b74a0e9 100644 --- a/doc/source/pyModeS.decoder.uncertainty.rst +++ b/doc/source/pyModeS.decoder.uncertainty.rst @@ -2,6 +2,6 @@ pyModeS.decoder.uncertainty module ================================== .. automodule:: pyModeS.decoder.uncertainty - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.decoder.uplink.rst b/doc/source/pyModeS.decoder.uplink.rst new file mode 100644 index 0000000..3520702 --- /dev/null +++ b/doc/source/pyModeS.decoder.uplink.rst @@ -0,0 +1,7 @@ +pyModeS.decoder.uplink module +============================= + +.. automodule:: pyModeS.decoder.uplink + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/source/pyModeS.extra.aero.rst b/doc/source/pyModeS.extra.aero.rst deleted file mode 100644 index 9ec9755..0000000 --- a/doc/source/pyModeS.extra.aero.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyModeS.extra.aero module -========================= - -.. automodule:: pyModeS.extra.aero - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/pyModeS.extra.rst b/doc/source/pyModeS.extra.rst deleted file mode 100644 index 0c38a7c..0000000 --- a/doc/source/pyModeS.extra.rst +++ /dev/null @@ -1,16 +0,0 @@ -pyModeS.extra package -===================== - -.. automodule:: pyModeS.extra - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - - pyModeS.extra.aero - pyModeS.extra.tcpclient - diff --git a/doc/source/pyModeS.extra.tcpclient.rst b/doc/source/pyModeS.extra.tcpclient.rst deleted file mode 100644 index 53d723a..0000000 --- a/doc/source/pyModeS.extra.tcpclient.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyModeS.extra.tcpclient module -============================== - -.. automodule:: pyModeS.extra.tcpclient - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/pyModeS.rst b/doc/source/pyModeS.rst index a2d4509..d24c1ca 100644 --- a/doc/source/pyModeS.rst +++ b/doc/source/pyModeS.rst @@ -2,16 +2,23 @@ pyModeS package =============== .. automodule:: pyModeS - :members: - :undoc-members: - :show-inheritance: + :members: + :undoc-members: + :show-inheritance: Subpackages ----------- .. toctree:: + :maxdepth: 4 - pyModeS.decoder - pyModeS.extra - pyModeS.streamer + pyModeS.decoder +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + pyModeS.c_common + pyModeS.common diff --git a/doc/source/pyModeS.streamer.rst b/doc/source/pyModeS.streamer.rst deleted file mode 100644 index 66f6a95..0000000 --- a/doc/source/pyModeS.streamer.rst +++ /dev/null @@ -1,16 +0,0 @@ -pyModeS.streamer package -======================== - -.. automodule:: pyModeS.streamer - :members: - :undoc-members: - :show-inheritance: - -Submodules ----------- - -.. toctree:: - - pyModeS.streamer.screen - pyModeS.streamer.stream - diff --git a/doc/source/pyModeS.streamer.screen.rst b/doc/source/pyModeS.streamer.screen.rst deleted file mode 100644 index 0fbddee..0000000 --- a/doc/source/pyModeS.streamer.screen.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyModeS.streamer.screen module -============================== - -.. automodule:: pyModeS.streamer.screen - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/source/pyModeS.streamer.stream.rst b/doc/source/pyModeS.streamer.stream.rst deleted file mode 100644 index 20d068e..0000000 --- a/doc/source/pyModeS.streamer.stream.rst +++ /dev/null @@ -1,7 +0,0 @@ -pyModeS.streamer.stream module -============================== - -.. automodule:: pyModeS.streamer.stream - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/warnings b/doc/warnings new file mode 100644 index 0000000..e69de29