From 89070a7c67abbf0b2a4b647eacfd2c59ed7b9671 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Tue, 6 May 2025 21:28:39 +0200 Subject: [PATCH] docs: Build the pySim.esim library documentation ... we added doc-strings but missed to actually render them in the manual so far. Change-Id: Iff2baca86376e68898a8af0252906f802ffa79eb --- docs/index.rst | 1 + docs/library-esim.rst | 95 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) create mode 100644 docs/library-esim.rst diff --git a/docs/index.rst b/docs/index.rst index 3c6d5d70..92be830a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,6 +43,7 @@ pySim consists of several parts: legacy smpp2sim library + library-esim osmo-smdpp sim-rest suci-keytool diff --git a/docs/library-esim.rst b/docs/library-esim.rst new file mode 100644 index 00000000..aae7110a --- /dev/null +++ b/docs/library-esim.rst @@ -0,0 +1,95 @@ +pySim eSIM libraries +==================== + +The pySim eSIM libraries implement a variety of functionality related to the GSMA eSIM universe, +including the various interfaces of SGP.21 + SGP.22, as well as Interoperable Profile decioding, +validation, personalization and encoding. + +.. automodule:: pySim.esim + :members: + + +GSMA SGP.21/22 Remote SIM Provisioning (RSP) - High Level +--------------------------------------------------------- + +pySim.esim.rsp +~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.rsp + :members: + +pySim.esim.es2p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es2p + :members: + + +pySim.esim.es8p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es8p + :members: + + +pySim.esim.es9p +~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.es9p + :members: + + +GSMA SGP.21/22 Remote SIM Provisioning (RSP) - Low Level +-------------------------------------------------------- + +pySim.esim.bsp +~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.bsp + :members: + +pySim.esim.http_json_api +~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.http_json_api + :members: + +pySim.esim.x509_cert +~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.x509_cert + :members: + +SIMalliance / TCA Interoperable Profile +--------------------------------------- + + +pySim.esim.saip +~~~~~~~~~~~~~~~ +.. automodule:: pySim.esim.saip + :members: + + +pySim.esim.saip.oid +~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.oid + :members: + +pySim.esim.saip.personalization +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.personalization + :members: + +pySim.esim.saip.templates +~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.templates + :members: + +pySim.esim.saip.validation +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. automodule:: pySim.esim.saip.validation + :members: