From aec4a2157fdfff0e64cd8417cfa887b9a195859b Mon Sep 17 00:00:00 2001 From: clerie Date: Thu, 6 Jan 2022 16:12:13 +0100 Subject: [PATCH] Add api documentation --- docs/Makefile | 20 ++++++++++ docs/api/mitel_ommclient2.messages.rst | 29 ++++++++++++++ docs/api/mitel_ommclient2.rst | 45 ++++++++++++++++++++++ docs/api/modules.rst | 9 +++++ docs/conf.py | 53 ++++++++++++++++++++++++++ docs/index.rst | 20 ++++++++++ docs/make.bat | 35 +++++++++++++++++ 7 files changed, 211 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/api/mitel_ommclient2.messages.rst create mode 100644 docs/api/mitel_ommclient2.rst create mode 100644 docs/api/modules.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# 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) diff --git a/docs/api/mitel_ommclient2.messages.rst b/docs/api/mitel_ommclient2.messages.rst new file mode 100644 index 0000000..2d29b75 --- /dev/null +++ b/docs/api/mitel_ommclient2.messages.rst @@ -0,0 +1,29 @@ +mitel\_ommclient2.messages package +================================== + +Submodules +---------- + +mitel\_ommclient2.messages.open module +-------------------------------------- + +.. automodule:: mitel_ommclient2.messages.open + :members: + :undoc-members: + :show-inheritance: + +mitel\_ommclient2.messages.ping module +-------------------------------------- + +.. automodule:: mitel_ommclient2.messages.ping + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: mitel_ommclient2.messages + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/mitel_ommclient2.rst b/docs/api/mitel_ommclient2.rst new file mode 100644 index 0000000..cc0189a --- /dev/null +++ b/docs/api/mitel_ommclient2.rst @@ -0,0 +1,45 @@ +mitel\_ommclient2 package +========================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + mitel_ommclient2.messages + +Submodules +---------- + +mitel\_ommclient2.client module +------------------------------- + +.. automodule:: mitel_ommclient2.client + :members: + :undoc-members: + :show-inheritance: + +mitel\_ommclient2.connection module +----------------------------------- + +.. automodule:: mitel_ommclient2.connection + :members: + :undoc-members: + :show-inheritance: + +mitel\_ommclient2.session module +-------------------------------- + +.. automodule:: mitel_ommclient2.session + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: mitel_ommclient2 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/api/modules.rst b/docs/api/modules.rst new file mode 100644 index 0000000..97c3221 --- /dev/null +++ b/docs/api/modules.rst @@ -0,0 +1,9 @@ +.. _api: + +mitel_ommclient2 +================ + +.. toctree:: + :maxdepth: 4 + + mitel_ommclient2 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..900304e --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,53 @@ +# 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 = 'Mitel OMMClient2' +copyright = '2022, clerie' +author = 'clerie' + + +# -- 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', +] + +# 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'] + + +# -- 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' + +# 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'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..9dfb1b2 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. Mitel OMMClient2 documentation master file, created by + sphinx-quickstart on Thu Jan 6 12:30:07 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Mitel OMMClient2's documentation! +============================================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +:ref:`api` + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..153be5e --- /dev/null +++ b/docs/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.https://www.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