From b9b9eb1f3b440510af7b5fed56d895cd156fde79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Marczykowski-G=C3=B3recki?= Date: Wed, 7 Mar 2018 01:34:42 +0100 Subject: [PATCH] doc: fix module index generation Result of `sphinx-apidoc qubesadmin` --- doc/conf.py | 5 +- doc/modules.rst | 7 ++ doc/qubesadmin.backup.rst | 38 ++++++ doc/qubesadmin.events.rst | 22 ++++ doc/qubesadmin.rst | 129 +++++++++++++++++++ doc/qubesadmin.tests.backup.rst | 22 ++++ doc/qubesadmin.tests.rst | 95 ++++++++++++++ doc/qubesadmin.tests.tools.rst | 214 ++++++++++++++++++++++++++++++++ doc/qubesadmin.tests.vm.rst | 46 +++++++ doc/qubesadmin.tools.rst | 214 ++++++++++++++++++++++++++++++++ doc/qubesadmin.vm.rst | 10 ++ 11 files changed, 801 insertions(+), 1 deletion(-) create mode 100644 doc/modules.rst create mode 100644 doc/qubesadmin.backup.rst create mode 100644 doc/qubesadmin.events.rst create mode 100644 doc/qubesadmin.rst create mode 100644 doc/qubesadmin.tests.backup.rst create mode 100644 doc/qubesadmin.tests.rst create mode 100644 doc/qubesadmin.tests.tools.rst create mode 100644 doc/qubesadmin.tests.vm.rst create mode 100644 doc/qubesadmin.tools.rst create mode 100644 doc/qubesadmin.vm.rst diff --git a/doc/conf.py b/doc/conf.py index 5be96ef..ec429c9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -404,4 +404,7 @@ texinfo_documents = [ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = { + 'python': ('https://docs.python.org/', None), + 'qubes': ('https://dev.qubes-os.org/projects/qubes-core-admin/en/latest', None), +} diff --git a/doc/modules.rst b/doc/modules.rst new file mode 100644 index 0000000..4c219ec --- /dev/null +++ b/doc/modules.rst @@ -0,0 +1,7 @@ +qubesadmin +========== + +.. toctree:: + :maxdepth: 4 + + qubesadmin diff --git a/doc/qubesadmin.backup.rst b/doc/qubesadmin.backup.rst new file mode 100644 index 0000000..c6b47d8 --- /dev/null +++ b/doc/qubesadmin.backup.rst @@ -0,0 +1,38 @@ +qubesadmin\.backup package +========================== + +Submodules +---------- + +qubesadmin\.backup\.core2 module +-------------------------------- + +.. automodule:: qubesadmin.backup.core2 + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.backup\.core3 module +-------------------------------- + +.. automodule:: qubesadmin.backup.core3 + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.backup\.restore module +---------------------------------- + +.. automodule:: qubesadmin.backup.restore + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin.backup + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.events.rst b/doc/qubesadmin.events.rst new file mode 100644 index 0000000..46b541b --- /dev/null +++ b/doc/qubesadmin.events.rst @@ -0,0 +1,22 @@ +qubesadmin\.events package +========================== + +Submodules +---------- + +qubesadmin\.events\.utils module +-------------------------------- + +.. automodule:: qubesadmin.events.utils + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin.events + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.rst b/doc/qubesadmin.rst new file mode 100644 index 0000000..c6ca571 --- /dev/null +++ b/doc/qubesadmin.rst @@ -0,0 +1,129 @@ +qubesadmin package +================== + +Subpackages +----------- + +.. toctree:: + + qubesadmin.backup + qubesadmin.events + qubesadmin.tests + qubesadmin.tools + qubesadmin.vm + +Submodules +---------- + +qubesadmin\.app module +---------------------- + +.. automodule:: qubesadmin.app + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.base module +----------------------- + +.. automodule:: qubesadmin.base + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.config module +------------------------- + +.. automodule:: qubesadmin.config + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.devices module +-------------------------- + +.. automodule:: qubesadmin.devices + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.exc module +---------------------- + +.. automodule:: qubesadmin.exc + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.features module +--------------------------- + +.. automodule:: qubesadmin.features + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.firewall module +--------------------------- + +.. automodule:: qubesadmin.firewall + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.label module +------------------------ + +.. automodule:: qubesadmin.label + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.log module +---------------------- + +.. automodule:: qubesadmin.log + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.spinner module +-------------------------- + +.. automodule:: qubesadmin.spinner + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.storage module +-------------------------- + +.. automodule:: qubesadmin.storage + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tags module +----------------------- + +.. automodule:: qubesadmin.tags + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.utils module +------------------------ + +.. automodule:: qubesadmin.utils + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.tests.backup.rst b/doc/qubesadmin.tests.backup.rst new file mode 100644 index 0000000..57a31a7 --- /dev/null +++ b/doc/qubesadmin.tests.backup.rst @@ -0,0 +1,22 @@ +qubesadmin\.tests\.backup package +================================= + +Submodules +---------- + +qubesadmin\.tests\.backup\.backupcompatibility module +----------------------------------------------------- + +.. automodule:: qubesadmin.tests.backup.backupcompatibility + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin.tests.backup + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.tests.rst b/doc/qubesadmin.tests.rst new file mode 100644 index 0000000..95abc00 --- /dev/null +++ b/doc/qubesadmin.tests.rst @@ -0,0 +1,95 @@ +qubesadmin\.tests package +========================= + +Subpackages +----------- + +.. toctree:: + + qubesadmin.tests.backup + qubesadmin.tests.tools + qubesadmin.tests.vm + +Submodules +---------- + +qubesadmin\.tests\.app module +----------------------------- + +.. automodule:: qubesadmin.tests.app + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.devices module +--------------------------------- + +.. automodule:: qubesadmin.tests.devices + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.errors module +-------------------------------- + +.. automodule:: qubesadmin.tests.errors + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.events module +-------------------------------- + +.. automodule:: qubesadmin.tests.events + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.features module +---------------------------------- + +.. automodule:: qubesadmin.tests.features + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.firewall module +---------------------------------- + +.. automodule:: qubesadmin.tests.firewall + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.label module +------------------------------- + +.. automodule:: qubesadmin.tests.label + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.storage module +--------------------------------- + +.. automodule:: qubesadmin.tests.storage + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tags module +------------------------------ + +.. automodule:: qubesadmin.tests.tags + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.tests.tools.rst b/doc/qubesadmin.tests.tools.rst new file mode 100644 index 0000000..eb88707 --- /dev/null +++ b/doc/qubesadmin.tests.tools.rst @@ -0,0 +1,214 @@ +qubesadmin\.tests\.tools package +================================ + +Submodules +---------- + +qubesadmin\.tests\.tools\.init module +------------------------------------- + +.. automodule:: qubesadmin.tests.tools.init + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qubes\_prefs module +--------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qubes_prefs + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_backup module +-------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_backup + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_backup\_restore module +----------------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_backup_restore + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_check module +------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_check + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_clone module +------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_clone + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_create module +-------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_create + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_device module +-------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_device + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_features module +---------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_features + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_firewall module +---------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_firewall + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_kill module +------------------------------------------ + +.. automodule:: qubesadmin.tests.tools.qvm_kill + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_ls module +---------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_ls + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_pause module +------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_pause + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_pool module +------------------------------------------ + +.. automodule:: qubesadmin.tests.tools.qvm_pool + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_prefs module +------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_prefs + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_remove module +-------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_remove + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_run module +----------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_run + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_service module +--------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_service + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_shutdown module +---------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_shutdown + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_start module +------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_start + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_start\_gui module +------------------------------------------------ + +.. automodule:: qubesadmin.tests.tools.qvm_start_gui + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_tags module +------------------------------------------ + +.. automodule:: qubesadmin.tests.tools.qvm_tags + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_template\_postprocess module +----------------------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_template_postprocess + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_unpause module +--------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_unpause + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.tools\.qvm\_volume module +-------------------------------------------- + +.. automodule:: qubesadmin.tests.tools.qvm_volume + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin.tests.tools + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.tests.vm.rst b/doc/qubesadmin.tests.vm.rst new file mode 100644 index 0000000..336bb27 --- /dev/null +++ b/doc/qubesadmin.tests.vm.rst @@ -0,0 +1,46 @@ +qubesadmin\.tests\.vm package +============================= + +Submodules +---------- + +qubesadmin\.tests\.vm\.actions module +------------------------------------- + +.. automodule:: qubesadmin.tests.vm.actions + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.vm\.dispvm module +------------------------------------ + +.. automodule:: qubesadmin.tests.vm.dispvm + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.vm\.properties module +---------------------------------------- + +.. automodule:: qubesadmin.tests.vm.properties + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tests\.vm\.storage module +------------------------------------- + +.. automodule:: qubesadmin.tests.vm.storage + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin.tests.vm + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.tools.rst b/doc/qubesadmin.tools.rst new file mode 100644 index 0000000..24de3fd --- /dev/null +++ b/doc/qubesadmin.tools.rst @@ -0,0 +1,214 @@ +qubesadmin\.tools package +========================= + +Submodules +---------- + +qubesadmin\.tools\.dochelpers module +------------------------------------ + +.. automodule:: qubesadmin.tools.dochelpers + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qubes\_prefs module +-------------------------------------- + +.. automodule:: qubesadmin.tools.qubes_prefs + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_backup module +------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_backup + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_backup\_restore module +---------------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_backup_restore + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_check module +------------------------------------ + +.. automodule:: qubesadmin.tools.qvm_check + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_clone module +------------------------------------ + +.. automodule:: qubesadmin.tools.qvm_clone + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_create module +------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_create + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_device module +------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_device + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_features module +--------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_features + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_firewall module +--------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_firewall + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_kill module +----------------------------------- + +.. automodule:: qubesadmin.tools.qvm_kill + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_ls module +--------------------------------- + +.. automodule:: qubesadmin.tools.qvm_ls + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_pause module +------------------------------------ + +.. automodule:: qubesadmin.tools.qvm_pause + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_pool module +----------------------------------- + +.. automodule:: qubesadmin.tools.qvm_pool + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_prefs module +------------------------------------ + +.. automodule:: qubesadmin.tools.qvm_prefs + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_remove module +------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_remove + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_run module +---------------------------------- + +.. automodule:: qubesadmin.tools.qvm_run + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_service module +-------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_service + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_shutdown module +--------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_shutdown + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_start module +------------------------------------ + +.. automodule:: qubesadmin.tools.qvm_start + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_start\_gui module +----------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_start_gui + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_tags module +----------------------------------- + +.. automodule:: qubesadmin.tools.qvm_tags + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_template\_postprocess module +---------------------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_template_postprocess + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_unpause module +-------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_unpause + :members: + :undoc-members: + :show-inheritance: + +qubesadmin\.tools\.qvm\_volume module +------------------------------------- + +.. automodule:: qubesadmin.tools.qvm_volume + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: qubesadmin.tools + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/qubesadmin.vm.rst b/doc/qubesadmin.vm.rst new file mode 100644 index 0000000..6b86d97 --- /dev/null +++ b/doc/qubesadmin.vm.rst @@ -0,0 +1,10 @@ +qubesadmin\.vm package +====================== + +Module contents +--------------- + +.. automodule:: qubesadmin.vm + :members: + :undoc-members: + :show-inheritance: