Add Sphinx support

.gitignore

@@ -5,5 +5,9 @@ __pycache__
 .idea
 .scannerwork
 
+# Sphinx
+_build
+_autosummary
+
 # Log files
 *.log

pydtn/docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pydtn/docs/_templates/autosummary/module.rst

+{{ fullname }}
+{{ underline }}
+
+.. contents::
+    :local:
+
+.. automodule:: {{fullname}}
+
+    Members
+    =======

pydtn/docs/conf.py

+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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 = 'pyDTN'
+copyright = '2019, X-works'
+author = 'X-works'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.autosummary',
+    'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+autoclass_content = "both"
+autodoc_default_options = {
+    "members": True,
+    "inherited-members": True,
+    "private-members": True,
+    "show-inheritance": True,
+}
+autosummary_generate = True
+napoleon_numpy_docstring = False
+napoleon_use_rtype = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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 = ['_static']
\ No newline at end of file

pydtn/docs/index.rst

+Welcome to pyDTN's documentation!
+=================================
+
+.. autosummary::
+   :toctree: _autosummary
+
+   pydtn
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pydtn/docs/make.bat

+@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% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pydtn/pydtn/__init__.py

+"""pyDTN
+
+Submodules
+==========
+
+.. autosummary::
+   :toctree: _autosummary
+
+   pydtn
+   bundle_protocol
+   encoding
+   tests
+   util
+"""
+
 from .pydtn import start

pydtn/pydtn/bundle_protocol/__init__.py

 """Bundle Protocol Version 7
 
+Submodules
+==========
+
+.. autosummary::
+   :toctree: _autosummary
+
+   bp
+   conn_manager
+   misc
+   convergence_layers
+
 Conforms to::
     https://tools.ietf.org/html/draft-ietf-dtn-bpbis-13
 

pydtn/pydtn/bundle_protocol/convergence_layers/__init__.py

 """Package containing Convergence Layer Adapters
 
+Submodules
+==========
+
+.. autosummary::
+   :toctree: _autosummary
+
+   api
+   streamed_cl_base
+   tcp_cl
+
 Conforms to::
     https://tools.ietf.org/html/draft-ietf-dtn-bpbis-13#section-7.1
 

pydtn/pydtn/encoding/__init__.py

+"""pyDTN encoding/decoding modules
+
+Submodules
+==========
+
+.. autosummary::
+   :toctree: _autosummary
+
+   bundle7
+   crc
+   ipnd
+   sdnv
+   tcpcl
+"""

pydtn/pydtn/tests/__init__.py

+"""pyDTN tests
+
+Submodules
+==========
+
+.. autosummary::
+   :toctree: _autosummary
+
+   bundle_7
+   common_unit
+"""

pydtn/pydtn/util/__init__.py

+"""pyDTN utils
+
+Submodules
+==========
+
+.. autosummary::
+   :toctree: _autosummary
+
+   aio_scheduler
+   exceptions
+   hexdump
+   io_util
+   misc
+   uio
+"""

pydtn_rest/docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

pydtn_rest/docs/_templates/autosummary/module.rst

+{{ fullname }}
+{{ underline }}
+
+.. contents::
+    :local:
+
+.. automodule:: {{fullname}}
+
+    Members
+    =======

pydtn_rest/docs/conf.py

+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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 = 'pyDNT-REST-API'
+copyright = '2019, X-works'
+author = 'X-works'
+
+# The full version, including alpha/beta/rc tags
+release = '1.0.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.autosummary',
+    'sphinx.ext.napoleon',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store']
+
+autoclass_content = "both"
+autodoc_default_options = {
+    "members": True,
+    "inherited-members": True,
+    "private-members": True,
+    "show-inheritance": True,
+}
+autosummary_generate = True
+napoleon_numpy_docstring = False
+napoleon_use_rtype = False
+
+
+# -- 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 = 'sphinx_rtd_theme'
+
+# 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 = ['_static']
\ No newline at end of file

pydtn_rest/docs/index.rst

+Welcome to pyDNT-REST-API's documentation!
+==========================================
+
+.. autosummary::
+   :toctree: _autosummary
+
+   pydtn_rest
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pydtn_rest/docs/make.bat

+@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% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

pydtn_rest/pydtn_rest/__init__.py

+"""pyDTN REST API
+
+Submodules
+==========
+
+.. autosummary::
+   :toctree: _autosummary
+
+   pydtn_rest
+"""
+
 from .pydtn_rest import start