[X2Go-Commits] [x2gobroker] 06/10: docs/source/: Exlcude unit tests from API documentation.
git-admin at x2go.org
git-admin at x2go.org
Fri Sep 7 11:02:34 CEST 2018
This is an automated email from the git hooks/post-receive script.
x2go pushed a commit to branch master
in repository x2gobroker.
commit 9fa4d0087f459e7f0a398c342e1e9460378affac
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date: Fri Sep 7 09:41:15 2018 +0200
docs/source/: Exlcude unit tests from API documentation.
---
Makefile.docupload | 2 +-
docs/source/conf.py | 2 +-
docs/source/x2gobroker.rst | 1 -
docs/source/x2gobroker.tests.rst | 27 ----------------------
docs/source/x2gobroker.tests.runalltests.rst | 7 ------
docs/source/x2gobroker.tests.test_broker_agent.rst | 7 ------
docs/source/x2gobroker.tests.test_broker_base.rst | 7 ------
.../x2gobroker.tests.test_broker_inifile.rst | 7 ------
.../x2gobroker.tests.test_broker_zeroconf.rst | 7 ------
.../x2gobroker.tests.test_client_plain_base.rst | 7 ------
docs/source/x2gobroker.tests.test_utils.rst | 7 ------
.../x2gobroker.tests.test_web_plain_base.rst | 7 ------
.../x2gobroker.tests.test_web_plain_inifile.rst | 7 ------
.../x2gobroker.tests.test_web_plain_zeroconf.rst | 7 ------
.../x2gobroker.tests.test_web_uccs_zeroconf.rst | 7 ------
15 files changed, 2 insertions(+), 107 deletions(-)
diff --git a/Makefile.docupload b/Makefile.docupload
index ce81287..1fba4b3 100644
--- a/Makefile.docupload
+++ b/Makefile.docupload
@@ -13,7 +13,7 @@ clean:
${MAKE} -C docs/ clean
apidoc:
- sphinx-apidoc -f -e -o docs/source/ x2gobroker
+ sphinx-apidoc -f -e -o docs/source/ x2gobroker x2gobroker/tests/
docbuild: clean
${MAKE} -C docs/ html SPHINXOPTS="-a -E"
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 336242e..498883c 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -94,7 +94,7 @@ language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'tests']
# The reST default role (used for this markup: `text`) to use for all
# documents.
diff --git a/docs/source/x2gobroker.rst b/docs/source/x2gobroker.rst
index c3b02b3..013d980 100644
--- a/docs/source/x2gobroker.rst
+++ b/docs/source/x2gobroker.rst
@@ -11,7 +11,6 @@ Subpackages
x2gobroker.client
x2gobroker.nameservices
x2gobroker.optional_scripts
- x2gobroker.tests
x2gobroker.web
Submodules
diff --git a/docs/source/x2gobroker.tests.rst b/docs/source/x2gobroker.tests.rst
deleted file mode 100644
index 8aca2fc..0000000
--- a/docs/source/x2gobroker.tests.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-x2gobroker.tests package
-========================
-
-Submodules
-----------
-
-.. toctree::
-
- x2gobroker.tests.runalltests
- x2gobroker.tests.test_broker_agent
- x2gobroker.tests.test_broker_base
- x2gobroker.tests.test_broker_inifile
- x2gobroker.tests.test_broker_zeroconf
- x2gobroker.tests.test_client_plain_base
- x2gobroker.tests.test_utils
- x2gobroker.tests.test_web_plain_base
- x2gobroker.tests.test_web_plain_inifile
- x2gobroker.tests.test_web_plain_zeroconf
- x2gobroker.tests.test_web_uccs_zeroconf
-
-Module contents
----------------
-
-.. automodule:: x2gobroker.tests
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.runalltests.rst b/docs/source/x2gobroker.tests.runalltests.rst
deleted file mode 100644
index 363ca37..0000000
--- a/docs/source/x2gobroker.tests.runalltests.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.runalltests module
-===================================
-
-.. automodule:: x2gobroker.tests.runalltests
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_broker_agent.rst b/docs/source/x2gobroker.tests.test_broker_agent.rst
deleted file mode 100644
index f3a2fff..0000000
--- a/docs/source/x2gobroker.tests.test_broker_agent.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_broker_agent module
-=========================================
-
-.. automodule:: x2gobroker.tests.test_broker_agent
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_broker_base.rst b/docs/source/x2gobroker.tests.test_broker_base.rst
deleted file mode 100644
index 8f99c29..0000000
--- a/docs/source/x2gobroker.tests.test_broker_base.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_broker_base module
-========================================
-
-.. automodule:: x2gobroker.tests.test_broker_base
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_broker_inifile.rst b/docs/source/x2gobroker.tests.test_broker_inifile.rst
deleted file mode 100644
index a614c27..0000000
--- a/docs/source/x2gobroker.tests.test_broker_inifile.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_broker_inifile module
-===========================================
-
-.. automodule:: x2gobroker.tests.test_broker_inifile
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_broker_zeroconf.rst b/docs/source/x2gobroker.tests.test_broker_zeroconf.rst
deleted file mode 100644
index 1cfa927..0000000
--- a/docs/source/x2gobroker.tests.test_broker_zeroconf.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_broker_zeroconf module
-============================================
-
-.. automodule:: x2gobroker.tests.test_broker_zeroconf
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_client_plain_base.rst b/docs/source/x2gobroker.tests.test_client_plain_base.rst
deleted file mode 100644
index 0b5cb33..0000000
--- a/docs/source/x2gobroker.tests.test_client_plain_base.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_client_plain_base module
-==============================================
-
-.. automodule:: x2gobroker.tests.test_client_plain_base
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_utils.rst b/docs/source/x2gobroker.tests.test_utils.rst
deleted file mode 100644
index 051a9f7..0000000
--- a/docs/source/x2gobroker.tests.test_utils.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_utils module
-==================================
-
-.. automodule:: x2gobroker.tests.test_utils
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_web_plain_base.rst b/docs/source/x2gobroker.tests.test_web_plain_base.rst
deleted file mode 100644
index 0cfafa3..0000000
--- a/docs/source/x2gobroker.tests.test_web_plain_base.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_web_plain_base module
-===========================================
-
-.. automodule:: x2gobroker.tests.test_web_plain_base
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_web_plain_inifile.rst b/docs/source/x2gobroker.tests.test_web_plain_inifile.rst
deleted file mode 100644
index d7f7f60..0000000
--- a/docs/source/x2gobroker.tests.test_web_plain_inifile.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_web_plain_inifile module
-==============================================
-
-.. automodule:: x2gobroker.tests.test_web_plain_inifile
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_web_plain_zeroconf.rst b/docs/source/x2gobroker.tests.test_web_plain_zeroconf.rst
deleted file mode 100644
index 6911727..0000000
--- a/docs/source/x2gobroker.tests.test_web_plain_zeroconf.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_web_plain_zeroconf module
-===============================================
-
-.. automodule:: x2gobroker.tests.test_web_plain_zeroconf
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/source/x2gobroker.tests.test_web_uccs_zeroconf.rst b/docs/source/x2gobroker.tests.test_web_uccs_zeroconf.rst
deleted file mode 100644
index cdbdc0f..0000000
--- a/docs/source/x2gobroker.tests.test_web_uccs_zeroconf.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-x2gobroker.tests.test_web_uccs_zeroconf module
-==============================================
-
-.. automodule:: x2gobroker.tests.test_web_uccs_zeroconf
- :members:
- :undoc-members:
- :show-inheritance:
--
Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/x2gobroker.git
More information about the x2go-commits
mailing list