[X2Go-Commits] [x2gobroker] 08/10: debian/: New bin:pkg python-x2gobroker-doc. Build API documentation with Sphinx and include it in a separate -doc package.

git-admin at x2go.org git-admin at x2go.org
Fri Sep 7 11:02:36 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 ded0c51082883820cb07206eab96400671ae3419
Author: Mike Gabriel <mike.gabriel at das-netzwerkteam.de>
Date:   Fri Sep 7 10:56:52 2018 +0200

    debian/: New bin:pkg python-x2gobroker-doc. Build API documentation with Sphinx and include it in a separate -doc package.
---
 debian/control                        | 28 ++++++++++++++++++++++++++++
 debian/python-x2gobroker-doc.doc-base | 10 ++++++++++
 debian/python-x2gobroker-doc.docs     |  1 +
 debian/python-x2gobroker-doc.links    |  3 +++
 debian/rules                          |  6 ++++++
 debian/x2gobroker.docs                |  2 +-
 6 files changed, 49 insertions(+), 1 deletion(-)

diff --git a/debian/control b/debian/control
index c122b1e..d3f02a3 100644
--- a/debian/control
+++ b/debian/control
@@ -16,6 +16,7 @@ Build-Depends:
  python3-setuptools,
  python3-nose,
  python3-paste,
+ python3-sphinx,
 Standards-Version: 4.1.0
 XS-Python-Version: >= 3.4
 
@@ -113,6 +114,33 @@ Description: X2Go Session Broker (Python3 modules)
  This package contains common files needed by all X2Go session
  brokers being package for this distribution.
 
+
+Package: python-x2gobroker-doc
+Section: doc
+Architecture: all
+Depends:
+ ${misc:Depends},
+ libjs-jquery,
+ libjs-underscore,
+Description: X2Go Session Broker (Python3 module documentation)
+ X2Go is a server based computing environment with
+    - session resuming
+    - low bandwidth support
+    - session brokerage support
+    - client side mass storage mounting support
+    - client side printing support
+    - audio support
+    - authentication by smartcard and USB stick
+ .
+ The session broker is a server tool for X2Go that tells your X2Go Client
+ application in a terminal server cluster what servers and session types are
+ most appropriate for the user in front of the X2Go terminal.
+ .
+ A session broker is most useful in load balanced X2Go server farms.
+ .
+ This package contains the API documentation of the various X2Go Broker
+ backends and shows how to extend the X2Go Session Broker.
+
 Package: x2gobroker-authservice
 Architecture: all
 Depends:
diff --git a/debian/python-x2gobroker-doc.doc-base b/debian/python-x2gobroker-doc.doc-base
new file mode 100644
index 0000000..b2e0156
--- /dev/null
+++ b/debian/python-x2gobroker-doc.doc-base
@@ -0,0 +1,10 @@
+Document: python-x2gobroker
+Title: Python X2Go Broker API
+Author: Mike Gabriel
+Abstract: This document describes the internals of the X2Go Session Broker and
+  how to extend it
+Section: Programming/Python
+
+Format: HTML
+Index: /usr/share/doc/python-x2gobroker-doc/html/index.html
+Files: /usr/share/doc/python-x2gobroker-doc/html/*
diff --git a/debian/python-x2gobroker-doc.docs b/debian/python-x2gobroker-doc.docs
new file mode 100644
index 0000000..ef1c0c7
--- /dev/null
+++ b/debian/python-x2gobroker-doc.docs
@@ -0,0 +1 @@
+docs/build/html/
diff --git a/debian/python-x2gobroker-doc.links b/debian/python-x2gobroker-doc.links
new file mode 100644
index 0000000..01dbc36
--- /dev/null
+++ b/debian/python-x2gobroker-doc.links
@@ -0,0 +1,3 @@
+usr/share/doc/python-x2gobroker-doc/html usr/share/doc/python3-x2gobroker/html
+usr/share/javascript/jquery/jquery.js usr/share/doc/python-x2gobroker-doc/html/_static/jquery.js
+usr/share/javascript/underscore/underscore.js usr/share/doc/python-x2gobroker-doc/html/_static/underscore.js
diff --git a/debian/rules b/debian/rules
index 4fdc8f6..0bb7614 100755
--- a/debian/rules
+++ b/debian/rules
@@ -37,6 +37,11 @@ DEB_PYTHON_SYSTEM = $(shell test -f /usr/bin/dh_python3 && echo "" || echo "pysu
 
 include /usr/share/cdbs/1/class/python-distutils.mk
 
+configure/python-x2gobroker-doc::
+	if [ ! -f docs/build/html/index.html ]; then \
+		make -f Makefile.docupload docbuild; \
+	fi
+
 common-binary-indep::
 	cp pam/x2gobroker.Debian pam/x2gobroker
 	cp x2gobroker-ssh.sudo x2gobroker-ssh
@@ -45,6 +50,7 @@ common-binary-arch:: common-binary-indep
 common-binary-post-install-arch:: list-missing
 
 clean::
+	make -f Makefile.docupload clean
 	rm -f pam/x2gobroker
 	rm -f lib/x2gobroker-agent
 	rm -f x2gobroker-ssh
diff --git a/debian/x2gobroker.docs b/debian/x2gobroker.docs
index 1c04808..b71571a 100644
--- a/debian/x2gobroker.docs
+++ b/debian/x2gobroker.docs
@@ -1 +1 @@
-doc/README.x2goclient+broker.getting-started
\ No newline at end of file
+docs/README.x2goclient+broker.getting-started.md
\ No newline at end of file

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