FGFS-4.1/pyModeS
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update API doc

Browse Source
This commit is contained in:
Junzi Sun
2020-05-04 01:07:02 +02:00
parent b51facbdc6
commit 11a560dbb5
40 changed files with 181 additions and 228 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/Makefile
+1 -1
View File
@@ -17,5 +17,5 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile %: Makefile
rm -f source/pyModeS*.rst source/modules.rst 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) @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
doc/source/conf.py
+33 -29
View File
@@ -14,19 +14,20 @@
# #
import os import os
import sys import sys
sys.path.insert(0, os.path.abspath('../..'))
sys.path.insert(0, os.path.abspath("../.."))
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
project = 'pyModeS' project = "pyModeS"
copyright = '2019, Junzi Sun' copyright = "2019, Junzi Sun"
author = 'Junzi Sun' author = "Junzi Sun"
# The short X.Y version # The short X.Y version
version = '' version = ""
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '' release = ""
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
@@ -39,13 +40,13 @@ release = ''
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'sphinx.ext.autodoc', "sphinx.ext.autodoc",
'sphinx.ext.todo', "sphinx.ext.todo",
'sphinx.ext.coverage', "sphinx.ext.coverage",
'sphinx.ext.mathjax', "sphinx.ext.mathjax",
'sphinx.ext.viewcode', "sphinx.ext.viewcode",
'sphinx.ext.githubpages', "sphinx.ext.githubpages",
'sphinx.ext.napoleon', "sphinx.ext.napoleon",
] ]
# Add any paths that contain templates here, relative to this directory. # 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: # You can specify multiple suffix as a list of string:
# #
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
source_suffix = '.rst' source_suffix = ".rst"
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = "index"
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@@ -82,6 +83,10 @@ pygments_style = None
# a list of builtin themes. # a list of builtin themes.
# #
# html_theme = 'alabaster' # 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 # 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 # further. For a list of options available for each theme, see the
@@ -108,7 +113,7 @@ pygments_style = None
# -- Options for HTMLHelp output --------------------------------------------- # -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'pyModeSdoc' htmlhelp_basename = "pyModeSdoc"
# -- Options for LaTeX output ------------------------------------------------ # -- Options for LaTeX output ------------------------------------------------
@@ -117,15 +122,12 @@ latex_elements = {
# The paper size ('letterpaper' or 'a4paper'). # The paper size ('letterpaper' or 'a4paper').
# #
# 'papersize': 'letterpaper', # 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt'). # The font size ('10pt', '11pt' or '12pt').
# #
# 'pointsize': '10pt', # 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble. # Additional stuff for the LaTeX preamble.
# #
# 'preamble': '', # 'preamble': '',
# Latex figure (float) alignment # Latex figure (float) alignment
# #
# 'figure_align': 'htbp', # 'figure_align': 'htbp',
@@ -135,8 +137,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'pyModeS.tex', 'pyModeS Documentation', (master_doc, "pyModeS.tex", "pyModeS Documentation", "Junzi Sun", "manual")
'Junzi Sun', 'manual'),
] ]
@@ -144,10 +145,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [(master_doc, "pymodes", "pyModeS Documentation", [author], 1)]
(master_doc, 'pymodes', 'pyModeS Documentation',
[author], 1)
]
# -- Options for Texinfo output ---------------------------------------------- # -- Options for Texinfo output ----------------------------------------------
@@ -156,9 +154,15 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'pyModeS', 'pyModeS Documentation', (
author, 'pyModeS', 'One line description of project.', master_doc,
'Miscellaneous'), "pyModeS",
"pyModeS Documentation",
author,
"pyModeS",
"One line description of project.",
"Miscellaneous",
)
] ]
@@ -177,7 +181,7 @@ epub_title = project
# epub_uid = '' # epub_uid = ''
# A list of files that should not be packed into the epub file. # 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 ------------------------------------------------- # -- Extension configuration -------------------------------------------------
doc/source/index.rst
+42 -4
View File
@@ -9,11 +9,49 @@ Welcome to pyModeS documentation!
The source code can be found at: https://github.com/junzis/pyModeS The source code can be found at: https://github.com/junzis/pyModeS
.. toctree:: .. 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
---- ----
doc/source/make.bat
-35
View File
@@ -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
doc/source/pyModeS.c_common.rst
+7
View File
@@ -0,0 +1,7 @@
pyModeS.c\_common module
========================
.. automodule:: pyModeS.c_common
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.common.rst
+7
View File
@@ -0,0 +1,7 @@
pyModeS.common module
=====================
.. automodule:: pyModeS.common
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.decoder.acas.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.acas module
=========================== ===========================
.. automodule:: pyModeS.decoder.acas .. automodule:: pyModeS.decoder.acas
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.adsb.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.adsb module
=========================== ===========================
.. automodule:: pyModeS.decoder.adsb .. automodule:: pyModeS.decoder.adsb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.allcall.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.allcall module
============================== ==============================
.. automodule:: pyModeS.decoder.allcall .. automodule:: pyModeS.decoder.allcall
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds05.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds05 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds05 .. automodule:: pyModeS.decoder.bds.bds05
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds06.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds06 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds06 .. automodule:: pyModeS.decoder.bds.bds06
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds08.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds08 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds08 .. automodule:: pyModeS.decoder.bds.bds08
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds09.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds09 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds09 .. automodule:: pyModeS.decoder.bds.bds09
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds10.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds10 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds10 .. automodule:: pyModeS.decoder.bds.bds10
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds17.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds17 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds17 .. automodule:: pyModeS.decoder.bds.bds17
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds20.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds20 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds20 .. automodule:: pyModeS.decoder.bds.bds20
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds30.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds30 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds30 .. automodule:: pyModeS.decoder.bds.bds30
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds40.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds40 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds40 .. automodule:: pyModeS.decoder.bds.bds40
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds44.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds44 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds44 .. automodule:: pyModeS.decoder.bds.bds44
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds45.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds45 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds45 .. automodule:: pyModeS.decoder.bds.bds45
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds50.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds50 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds50 .. automodule:: pyModeS.decoder.bds.bds50
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds53.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds53 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds53 .. automodule:: pyModeS.decoder.bds.bds53
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.bds60.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.bds.bds60 module
================================ ================================
.. automodule:: pyModeS.decoder.bds.bds60 .. automodule:: pyModeS.decoder.bds.bds60
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.bds.rst
+4 -4
View File
@@ -2,14 +2,15 @@ pyModeS.decoder.bds package
=========================== ===========================
.. automodule:: pyModeS.decoder.bds .. automodule:: pyModeS.decoder.bds
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Submodules Submodules
---------- ----------
.. toctree:: .. toctree::
:maxdepth: 4
pyModeS.decoder.bds.bds05 pyModeS.decoder.bds.bds05
pyModeS.decoder.bds.bds06 pyModeS.decoder.bds.bds06
@@ -25,4 +26,3 @@ Submodules
pyModeS.decoder.bds.bds50 pyModeS.decoder.bds.bds50
pyModeS.decoder.bds.bds53 pyModeS.decoder.bds.bds53
pyModeS.decoder.bds.bds60 pyModeS.decoder.bds.bds60
doc/source/pyModeS.decoder.commb.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.commb module
============================ ============================
.. automodule:: pyModeS.decoder.commb .. automodule:: pyModeS.decoder.commb
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.common.rst
-7
View File
@@ -1,7 +0,0 @@
pyModeS.decoder.common module
=============================
.. automodule:: pyModeS.decoder.common
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.decoder.ehs.rst
-7
View File
@@ -1,7 +0,0 @@
pyModeS.decoder.ehs module
==========================
.. automodule:: pyModeS.decoder.ehs
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.decoder.els.rst
-7
View File
@@ -1,7 +0,0 @@
pyModeS.decoder.els module
==========================
.. automodule:: pyModeS.decoder.els
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.decoder.rst
+7 -8
View File
@@ -2,29 +2,28 @@ pyModeS.decoder package
======================= =======================
.. automodule:: pyModeS.decoder .. automodule:: pyModeS.decoder
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Subpackages Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
pyModeS.decoder.bds pyModeS.decoder.bds
Submodules Submodules
---------- ----------
.. toctree:: .. toctree::
:maxdepth: 4
pyModeS.decoder.acas pyModeS.decoder.acas
pyModeS.decoder.adsb pyModeS.decoder.adsb
pyModeS.decoder.allcall pyModeS.decoder.allcall
pyModeS.decoder.commb pyModeS.decoder.commb
pyModeS.decoder.common
pyModeS.decoder.ehs
pyModeS.decoder.els
pyModeS.decoder.surv pyModeS.decoder.surv
pyModeS.decoder.uncertainty pyModeS.decoder.uncertainty
pyModeS.decoder.uplink
doc/source/pyModeS.decoder.surv.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.surv module
=========================== ===========================
.. automodule:: pyModeS.decoder.surv .. automodule:: pyModeS.decoder.surv
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.uncertainty.rst
+3 -3
View File
@@ -2,6 +2,6 @@ pyModeS.decoder.uncertainty module
================================== ==================================
.. automodule:: pyModeS.decoder.uncertainty .. automodule:: pyModeS.decoder.uncertainty
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
doc/source/pyModeS.decoder.uplink.rst
+7
View File
@@ -0,0 +1,7 @@
pyModeS.decoder.uplink module
=============================
.. automodule:: pyModeS.decoder.uplink
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.extra.aero.rst
-7
View File
@@ -1,7 +0,0 @@
pyModeS.extra.aero module
=========================
.. automodule:: pyModeS.extra.aero
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.extra.rst
-16
View File
@@ -1,16 +0,0 @@
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
-7
View File
@@ -1,7 +0,0 @@
pyModeS.extra.tcpclient module
==============================
.. automodule:: pyModeS.extra.tcpclient
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.rst
+13 -6
View File
@@ -2,16 +2,23 @@ pyModeS package
=============== ===============
.. automodule:: pyModeS .. automodule:: pyModeS
:members: :members:
:undoc-members: :undoc-members:
:show-inheritance: :show-inheritance:
Subpackages Subpackages
----------- -----------
.. toctree:: .. toctree::
:maxdepth: 4
pyModeS.decoder pyModeS.decoder
pyModeS.extra
pyModeS.streamer
Submodules
----------
.. toctree::
:maxdepth: 4
pyModeS.c_common
pyModeS.common
doc/source/pyModeS.streamer.rst
-16
View File
@@ -1,16 +0,0 @@
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
-7
View File
@@ -1,7 +0,0 @@
pyModeS.streamer.screen module
==============================
.. automodule:: pyModeS.streamer.screen
:members:
:undoc-members:
:show-inheritance:
doc/source/pyModeS.streamer.stream.rst
-7
View File
@@ -1,7 +0,0 @@
pyModeS.streamer.stream module
==============================
.. automodule:: pyModeS.streamer.stream
:members:
:undoc-members:
:show-inheritance:
doc/warnings
View File