Python: Sphinx doc files

6 files changed, 193 insertions, 0 deletions

diff --git a/wrappers/python/docs/Makefile b/wrappers/python/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/wrappers/python/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     = source
+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/wrappers/python/docs/make.bat b/wrappers/python/docs/make.bat
new file mode 100644
index 0000000..747ffb7
--- /dev/null
+++ b/wrappers/python/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=source

+set BUILDDIR=build

+

+%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

+)

+

+if "%1" == "" goto help

+

+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

+goto end

+

+:help

+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

+

+:end

+popd

diff --git a/wrappers/python/docs/source/conf.py b/wrappers/python/docs/source/conf.py
new file mode 100644
index 0000000..89da513
--- /dev/null
+++ b/wrappers/python/docs/source/conf.py
@@ -0,0 +1,32 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import sphinx_rtd_theme
+
+project = 'python-eduvpn-common'
+copyright = '2022, Jeroen Wijenbergh'
+author = 'Jeroen Wijenbergh'
+release = '0.1.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx_rtd_theme',
+]
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
diff --git a/wrappers/python/docs/source/eduvpn_common.rst b/wrappers/python/docs/source/eduvpn_common.rst
new file mode 100644
index 0000000..f09cff3
--- /dev/null
+++ b/wrappers/python/docs/source/eduvpn_common.rst
@@ -0,0 +1,77 @@
+eduvpn\_common package
+======================
+
+Submodules
+----------
+
+eduvpn\_common.discovery module
+-------------------------------
+
+.. automodule:: eduvpn_common.discovery
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eduvpn\_common.error module
+---------------------------
+
+.. automodule:: eduvpn_common.error
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eduvpn\_common.event module
+---------------------------
+
+.. automodule:: eduvpn_common.event
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eduvpn\_common.loader module
+----------------------------
+
+.. automodule:: eduvpn_common.loader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eduvpn\_common.main module
+--------------------------
+
+.. automodule:: eduvpn_common.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eduvpn\_common.server module
+----------------------------
+
+.. automodule:: eduvpn_common.server
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eduvpn\_common.state module
+---------------------------
+
+.. automodule:: eduvpn_common.state
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+eduvpn\_common.types module
+---------------------------
+
+.. automodule:: eduvpn_common.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: eduvpn_common
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/wrappers/python/docs/source/index.rst b/wrappers/python/docs/source/index.rst
new file mode 100644
index 0000000..995047c
--- /dev/null
+++ b/wrappers/python/docs/source/index.rst
@@ -0,0 +1,22 @@
+.. python-eduvpn-common documentation master file, created by
+   sphinx-quickstart on Fri Oct 21 15:03:04 2022.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to python-eduvpn-common's documentation!
+================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/wrappers/python/docs/source/modules.rst b/wrappers/python/docs/source/modules.rst
new file mode 100644
index 0000000..fec1e9e
--- /dev/null
+++ b/wrappers/python/docs/source/modules.rst
@@ -0,0 +1,7 @@
+eduvpn_common
+=============
+
+.. toctree::
+   :maxdepth: 4
+
+   eduvpn_common