This is an automated email from the git hooks/post-receive script. x2go pushed a commit to branch master in repository python-x2go. commit b0d14415812029b40b4288dcb208babd55c2b9cf Author: Mike Gabriel <mike.gabriel@das-netzwerkteam.de> Date: Mon Mar 5 22:07:24 2018 +0100 Start using Sphinx API documentation tool. --- docs/Makefile | 225 +++++++++++ docs/source/conf.py | 430 ++++++++++++++++++++++ docs/source/index.rst | 23 ++ docs/source/modules.rst | 7 + docs/source/x2go.backends.control.plain.rst | 7 + docs/source/x2go.backends.control.rst | 17 + docs/source/x2go.backends.info.plain.rst | 7 + docs/source/x2go.backends.info.rst | 17 + docs/source/x2go.backends.printing.file.rst | 7 + docs/source/x2go.backends.printing.rst | 18 + docs/source/x2go.backends.printing.winreg.rst | 7 + docs/source/x2go.backends.profiles.base.rst | 7 + docs/source/x2go.backends.profiles.file.rst | 7 + docs/source/x2go.backends.profiles.httpbroker.rst | 7 + docs/source/x2go.backends.profiles.rst | 21 ++ docs/source/x2go.backends.profiles.sshbroker.rst | 7 + docs/source/x2go.backends.profiles.winreg.rst | 7 + docs/source/x2go.backends.proxy.base.rst | 7 + docs/source/x2go.backends.proxy.nx3.rst | 7 + docs/source/x2go.backends.proxy.rst | 18 + docs/source/x2go.backends.rst | 23 ++ docs/source/x2go.backends.settings.file.rst | 7 + docs/source/x2go.backends.settings.rst | 18 + docs/source/x2go.backends.settings.winreg.rst | 7 + docs/source/x2go.backends.terminal.plain.rst | 7 + docs/source/x2go.backends.terminal.rst | 17 + docs/source/x2go.cache.rst | 7 + docs/source/x2go.checkhosts.rst | 7 + docs/source/x2go.cleanup.rst | 7 + docs/source/x2go.client.rst | 7 + docs/source/x2go.defaults.rst | 7 + docs/source/x2go.forward.rst | 7 + docs/source/x2go.gevent_subprocess.rst | 7 + docs/source/x2go.guardian.rst | 7 + docs/source/x2go.inifiles.rst | 7 + docs/source/x2go.log.rst | 7 + docs/source/x2go.mimebox.rst | 7 + docs/source/x2go.mimeboxactions.rst | 7 + docs/source/x2go.printactions.rst | 7 + docs/source/x2go.printqueue.rst | 7 + docs/source/x2go.pulseaudio.rst | 7 + docs/source/x2go.registry.rst | 7 + docs/source/x2go.rforward.rst | 7 + docs/source/x2go.rst | 48 +++ docs/source/x2go.session.rst | 7 + docs/source/x2go.sftpserver.rst | 7 + docs/source/x2go.sshproxy.rst | 7 + docs/source/x2go.telekinesis.rst | 7 + docs/source/x2go.tests.rst | 18 + docs/source/x2go.tests.runalltests.rst | 7 + docs/source/x2go.tests.test_printing.rst | 7 + docs/source/x2go.utils.rst | 7 + docs/source/x2go.x2go_exceptions.rst | 7 + docs/source/x2go.xserver.rst | 7 + 54 files changed, 1180 insertions(+) diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..016cf22 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,225 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = /usr/share/sphinx/scripts/python3/sphinx-build +PAPER = +BUILDDIR = build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help +help: + @echo "Please use \`make <target>' where <target> is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PythonX2Go.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PythonX2Go.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/PythonX2Go" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PythonX2Go" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..614b770 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,430 @@ +# -*- coding: utf-8 -*- +# +# x2go documentation build configuration file, created by +# sphinx-quickstart on Mon Mar 5 21:36:47 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../../')) +import x2go + +from datetime import date + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +# +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Python X2Go' +copyright = u'{year}, {author}'.format(year=date.today().year, author=x2go.__AUTHOR__) +author = u'{author}'.format(author=x2go.__AUTHOR__) + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = x2go.__VERSION__ +# The full version, including alpha/beta/rc tags. +release = x2go.__VERSION__ + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'en' + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# +# today = '' +# +# Else, today_fmt is used as the format for a strftime call. +# +# today_fmt = '%B %d, %Y' + +# 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'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. +# "<project> v<release> documentation" by default. +# +# html_title = u'x2go v' + +# A shorter title for the navigation bar. Default is the same as html_title. +# +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# +# html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# +# html_extra_path = [] + +# If not None, a 'Last updated on:' timestamp is inserted at every page +# bottom, using the given strftime format. +# The empty string is equivalent to '%b %d, %Y'. +# +# html_last_updated_fmt = None + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# +# html_additional_pages = {} + +# If false, no module index is generated. +# +# html_domain_indices = True + +# If false, no index is generated. +# +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a <link> tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh' +# +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# 'ja' uses this config value. +# 'zh' user can custom change `jieba` dictionary path. +# +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'x2godoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'x2go.tex', u'x2go Documentation', + u'Author', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# +# latex_use_parts = False + +# If true, show page references after internal links. +# +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# +# latex_appendices = [] + +# It false, will not define \strong, \code, itleref, \crossref ... but only +# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added +# packages. +# +# latex_keep_old_macro_names = True + +# If false, no module index is generated. +# +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'x2go', u'x2go Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +# +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'x2go', u'x2go Documentation', + author, 'x2go', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# +# texinfo_appendices = [] + +# If false, no module index is generated. +# +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# +# texinfo_no_detailmenu = False + + +# -- Options for Epub output ---------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project +epub_author = author +epub_publisher = author +epub_copyright = copyright + +# The basename for the epub file. It defaults to the project name. +# epub_basename = project + +# The HTML theme for the epub output. Since the default themes are not +# optimized for small screen space, using the same theme for HTML and epub +# output is usually not wise. This defaults to 'epub', a theme designed to save +# visual space. +# +# epub_theme = 'epub' + +# The language of the text. It defaults to the language option +# or 'en' if the language is not set. +# +# epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +# epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +# +# epub_cover = () + +# A sequence of (type, uri, title) tuples for the guide element of content.opf. +# +# epub_guide = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# +# epub_pre_files = [] + +# HTML files that should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +# +# epub_post_files = [] + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ['search.html'] + +# The depth of the table of contents in toc.ncx. +# +# epub_tocdepth = 3 + +# Allow duplicate toc entries. +# +# epub_tocdup = True + +# Choose between 'default' and 'includehidden'. +# +# epub_tocscope = 'default' + +# Fix unsupported image types using the Pillow. +# +# epub_fix_images = False + +# Scale large images. +# +# epub_max_image_width = 0 + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# +# epub_show_urls = 'inline' + +# If false, no index is generated. +# +# epub_use_index = True diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..9de0d56 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,23 @@ +.. Python X2Go documentation master file, created by + sphinx-quickstart on Mon Mar 5 21:36:47 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Python X2Go's documentation! +======================================= + +Contents: + +.. toctree:: + :maxdepth: 4 + + x2go + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..d4a7ecc --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +x2go +==== + +.. toctree:: + :maxdepth: 4 + + x2go diff --git a/docs/source/x2go.backends.control.plain.rst b/docs/source/x2go.backends.control.plain.rst new file mode 100644 index 0000000..020497e --- /dev/null +++ b/docs/source/x2go.backends.control.plain.rst @@ -0,0 +1,7 @@ +x2go.backends.control.plain module +================================== + +.. automodule:: x2go.backends.control.plain + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.control.rst b/docs/source/x2go.backends.control.rst new file mode 100644 index 0000000..084a1bf --- /dev/null +++ b/docs/source/x2go.backends.control.rst @@ -0,0 +1,17 @@ +x2go.backends.control package +============================= + +Submodules +---------- + +.. toctree:: + + x2go.backends.control.plain + +Module contents +--------------- + +.. automodule:: x2go.backends.control + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.info.plain.rst b/docs/source/x2go.backends.info.plain.rst new file mode 100644 index 0000000..803dd8b --- /dev/null +++ b/docs/source/x2go.backends.info.plain.rst @@ -0,0 +1,7 @@ +x2go.backends.info.plain module +=============================== + +.. automodule:: x2go.backends.info.plain + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.info.rst b/docs/source/x2go.backends.info.rst new file mode 100644 index 0000000..91f1b57 --- /dev/null +++ b/docs/source/x2go.backends.info.rst @@ -0,0 +1,17 @@ +x2go.backends.info package +========================== + +Submodules +---------- + +.. toctree:: + + x2go.backends.info.plain + +Module contents +--------------- + +.. automodule:: x2go.backends.info + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.printing.file.rst b/docs/source/x2go.backends.printing.file.rst new file mode 100644 index 0000000..a58002f --- /dev/null +++ b/docs/source/x2go.backends.printing.file.rst @@ -0,0 +1,7 @@ +x2go.backends.printing.file module +================================== + +.. automodule:: x2go.backends.printing.file + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.printing.rst b/docs/source/x2go.backends.printing.rst new file mode 100644 index 0000000..1872327 --- /dev/null +++ b/docs/source/x2go.backends.printing.rst @@ -0,0 +1,18 @@ +x2go.backends.printing package +============================== + +Submodules +---------- + +.. toctree:: + + x2go.backends.printing.file + x2go.backends.printing.winreg + +Module contents +--------------- + +.. automodule:: x2go.backends.printing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.printing.winreg.rst b/docs/source/x2go.backends.printing.winreg.rst new file mode 100644 index 0000000..3da1502 --- /dev/null +++ b/docs/source/x2go.backends.printing.winreg.rst @@ -0,0 +1,7 @@ +x2go.backends.printing.winreg module +==================================== + +.. automodule:: x2go.backends.printing.winreg + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.profiles.base.rst b/docs/source/x2go.backends.profiles.base.rst new file mode 100644 index 0000000..dc4e837 --- /dev/null +++ b/docs/source/x2go.backends.profiles.base.rst @@ -0,0 +1,7 @@ +x2go.backends.profiles.base module +================================== + +.. automodule:: x2go.backends.profiles.base + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.profiles.file.rst b/docs/source/x2go.backends.profiles.file.rst new file mode 100644 index 0000000..ac0621f --- /dev/null +++ b/docs/source/x2go.backends.profiles.file.rst @@ -0,0 +1,7 @@ +x2go.backends.profiles.file module +================================== + +.. automodule:: x2go.backends.profiles.file + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.profiles.httpbroker.rst b/docs/source/x2go.backends.profiles.httpbroker.rst new file mode 100644 index 0000000..aecffc9 --- /dev/null +++ b/docs/source/x2go.backends.profiles.httpbroker.rst @@ -0,0 +1,7 @@ +x2go.backends.profiles.httpbroker module +======================================== + +.. automodule:: x2go.backends.profiles.httpbroker + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.profiles.rst b/docs/source/x2go.backends.profiles.rst new file mode 100644 index 0000000..94a66b6 --- /dev/null +++ b/docs/source/x2go.backends.profiles.rst @@ -0,0 +1,21 @@ +x2go.backends.profiles package +============================== + +Submodules +---------- + +.. toctree:: + + x2go.backends.profiles.base + x2go.backends.profiles.file + x2go.backends.profiles.httpbroker + x2go.backends.profiles.sshbroker + x2go.backends.profiles.winreg + +Module contents +--------------- + +.. automodule:: x2go.backends.profiles + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.profiles.sshbroker.rst b/docs/source/x2go.backends.profiles.sshbroker.rst new file mode 100644 index 0000000..4d91576 --- /dev/null +++ b/docs/source/x2go.backends.profiles.sshbroker.rst @@ -0,0 +1,7 @@ +x2go.backends.profiles.sshbroker module +======================================= + +.. automodule:: x2go.backends.profiles.sshbroker + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.profiles.winreg.rst b/docs/source/x2go.backends.profiles.winreg.rst new file mode 100644 index 0000000..63ab6d3 --- /dev/null +++ b/docs/source/x2go.backends.profiles.winreg.rst @@ -0,0 +1,7 @@ +x2go.backends.profiles.winreg module +==================================== + +.. automodule:: x2go.backends.profiles.winreg + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.proxy.base.rst b/docs/source/x2go.backends.proxy.base.rst new file mode 100644 index 0000000..539d348 --- /dev/null +++ b/docs/source/x2go.backends.proxy.base.rst @@ -0,0 +1,7 @@ +x2go.backends.proxy.base module +=============================== + +.. automodule:: x2go.backends.proxy.base + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.proxy.nx3.rst b/docs/source/x2go.backends.proxy.nx3.rst new file mode 100644 index 0000000..956f833 --- /dev/null +++ b/docs/source/x2go.backends.proxy.nx3.rst @@ -0,0 +1,7 @@ +x2go.backends.proxy.nx3 module +============================== + +.. automodule:: x2go.backends.proxy.nx3 + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.proxy.rst b/docs/source/x2go.backends.proxy.rst new file mode 100644 index 0000000..afa52eb --- /dev/null +++ b/docs/source/x2go.backends.proxy.rst @@ -0,0 +1,18 @@ +x2go.backends.proxy package +=========================== + +Submodules +---------- + +.. toctree:: + + x2go.backends.proxy.base + x2go.backends.proxy.nx3 + +Module contents +--------------- + +.. automodule:: x2go.backends.proxy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.rst b/docs/source/x2go.backends.rst new file mode 100644 index 0000000..5da6e9a --- /dev/null +++ b/docs/source/x2go.backends.rst @@ -0,0 +1,23 @@ +x2go.backends package +===================== + +Subpackages +----------- + +.. toctree:: + + x2go.backends.control + x2go.backends.info + x2go.backends.printing + x2go.backends.profiles + x2go.backends.proxy + x2go.backends.settings + x2go.backends.terminal + +Module contents +--------------- + +.. automodule:: x2go.backends + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.settings.file.rst b/docs/source/x2go.backends.settings.file.rst new file mode 100644 index 0000000..d88ffa1 --- /dev/null +++ b/docs/source/x2go.backends.settings.file.rst @@ -0,0 +1,7 @@ +x2go.backends.settings.file module +================================== + +.. automodule:: x2go.backends.settings.file + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.settings.rst b/docs/source/x2go.backends.settings.rst new file mode 100644 index 0000000..b83028d --- /dev/null +++ b/docs/source/x2go.backends.settings.rst @@ -0,0 +1,18 @@ +x2go.backends.settings package +============================== + +Submodules +---------- + +.. toctree:: + + x2go.backends.settings.file + x2go.backends.settings.winreg + +Module contents +--------------- + +.. automodule:: x2go.backends.settings + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.settings.winreg.rst b/docs/source/x2go.backends.settings.winreg.rst new file mode 100644 index 0000000..fd9a927 --- /dev/null +++ b/docs/source/x2go.backends.settings.winreg.rst @@ -0,0 +1,7 @@ +x2go.backends.settings.winreg module +==================================== + +.. automodule:: x2go.backends.settings.winreg + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.terminal.plain.rst b/docs/source/x2go.backends.terminal.plain.rst new file mode 100644 index 0000000..f40874f --- /dev/null +++ b/docs/source/x2go.backends.terminal.plain.rst @@ -0,0 +1,7 @@ +x2go.backends.terminal.plain module +=================================== + +.. automodule:: x2go.backends.terminal.plain + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.backends.terminal.rst b/docs/source/x2go.backends.terminal.rst new file mode 100644 index 0000000..9258da3 --- /dev/null +++ b/docs/source/x2go.backends.terminal.rst @@ -0,0 +1,17 @@ +x2go.backends.terminal package +============================== + +Submodules +---------- + +.. toctree:: + + x2go.backends.terminal.plain + +Module contents +--------------- + +.. automodule:: x2go.backends.terminal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.cache.rst b/docs/source/x2go.cache.rst new file mode 100644 index 0000000..d41919a --- /dev/null +++ b/docs/source/x2go.cache.rst @@ -0,0 +1,7 @@ +x2go.cache module +================= + +.. automodule:: x2go.cache + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.checkhosts.rst b/docs/source/x2go.checkhosts.rst new file mode 100644 index 0000000..9ec576c --- /dev/null +++ b/docs/source/x2go.checkhosts.rst @@ -0,0 +1,7 @@ +x2go.checkhosts module +====================== + +.. automodule:: x2go.checkhosts + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.cleanup.rst b/docs/source/x2go.cleanup.rst new file mode 100644 index 0000000..b0125bb --- /dev/null +++ b/docs/source/x2go.cleanup.rst @@ -0,0 +1,7 @@ +x2go.cleanup module +=================== + +.. automodule:: x2go.cleanup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.client.rst b/docs/source/x2go.client.rst new file mode 100644 index 0000000..158c1d3 --- /dev/null +++ b/docs/source/x2go.client.rst @@ -0,0 +1,7 @@ +x2go.client module +================== + +.. automodule:: x2go.client + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.defaults.rst b/docs/source/x2go.defaults.rst new file mode 100644 index 0000000..a7593f7 --- /dev/null +++ b/docs/source/x2go.defaults.rst @@ -0,0 +1,7 @@ +x2go.defaults module +==================== + +.. automodule:: x2go.defaults + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.forward.rst b/docs/source/x2go.forward.rst new file mode 100644 index 0000000..e6fb7f7 --- /dev/null +++ b/docs/source/x2go.forward.rst @@ -0,0 +1,7 @@ +x2go.forward module +=================== + +.. automodule:: x2go.forward + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.gevent_subprocess.rst b/docs/source/x2go.gevent_subprocess.rst new file mode 100644 index 0000000..862b296 --- /dev/null +++ b/docs/source/x2go.gevent_subprocess.rst @@ -0,0 +1,7 @@ +x2go.gevent_subprocess module +============================= + +.. automodule:: x2go.gevent_subprocess + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.guardian.rst b/docs/source/x2go.guardian.rst new file mode 100644 index 0000000..24cf768 --- /dev/null +++ b/docs/source/x2go.guardian.rst @@ -0,0 +1,7 @@ +x2go.guardian module +==================== + +.. automodule:: x2go.guardian + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.inifiles.rst b/docs/source/x2go.inifiles.rst new file mode 100644 index 0000000..5ebf6e2 --- /dev/null +++ b/docs/source/x2go.inifiles.rst @@ -0,0 +1,7 @@ +x2go.inifiles module +==================== + +.. automodule:: x2go.inifiles + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.log.rst b/docs/source/x2go.log.rst new file mode 100644 index 0000000..73a4db7 --- /dev/null +++ b/docs/source/x2go.log.rst @@ -0,0 +1,7 @@ +x2go.log module +=============== + +.. automodule:: x2go.log + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.mimebox.rst b/docs/source/x2go.mimebox.rst new file mode 100644 index 0000000..0ae0ee2 --- /dev/null +++ b/docs/source/x2go.mimebox.rst @@ -0,0 +1,7 @@ +x2go.mimebox module +=================== + +.. automodule:: x2go.mimebox + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.mimeboxactions.rst b/docs/source/x2go.mimeboxactions.rst new file mode 100644 index 0000000..1fa9084 --- /dev/null +++ b/docs/source/x2go.mimeboxactions.rst @@ -0,0 +1,7 @@ +x2go.mimeboxactions module +========================== + +.. automodule:: x2go.mimeboxactions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.printactions.rst b/docs/source/x2go.printactions.rst new file mode 100644 index 0000000..f8f0ef1 --- /dev/null +++ b/docs/source/x2go.printactions.rst @@ -0,0 +1,7 @@ +x2go.printactions module +======================== + +.. automodule:: x2go.printactions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.printqueue.rst b/docs/source/x2go.printqueue.rst new file mode 100644 index 0000000..bd847f2 --- /dev/null +++ b/docs/source/x2go.printqueue.rst @@ -0,0 +1,7 @@ +x2go.printqueue module +====================== + +.. automodule:: x2go.printqueue + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.pulseaudio.rst b/docs/source/x2go.pulseaudio.rst new file mode 100644 index 0000000..1430438 --- /dev/null +++ b/docs/source/x2go.pulseaudio.rst @@ -0,0 +1,7 @@ +x2go.pulseaudio module +====================== + +.. automodule:: x2go.pulseaudio + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.registry.rst b/docs/source/x2go.registry.rst new file mode 100644 index 0000000..9e3eaf0 --- /dev/null +++ b/docs/source/x2go.registry.rst @@ -0,0 +1,7 @@ +x2go.registry module +==================== + +.. automodule:: x2go.registry + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.rforward.rst b/docs/source/x2go.rforward.rst new file mode 100644 index 0000000..28c6b1b --- /dev/null +++ b/docs/source/x2go.rforward.rst @@ -0,0 +1,7 @@ +x2go.rforward module +==================== + +.. automodule:: x2go.rforward + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.rst b/docs/source/x2go.rst new file mode 100644 index 0000000..b2bddc7 --- /dev/null +++ b/docs/source/x2go.rst @@ -0,0 +1,48 @@ +x2go package +============ + +Subpackages +----------- + +.. toctree:: + + x2go.backends + x2go.tests + +Submodules +---------- + +.. toctree:: + + x2go.cache + x2go.checkhosts + x2go.cleanup + x2go.client + x2go.defaults + x2go.forward + x2go.gevent_subprocess + x2go.guardian + x2go.inifiles + x2go.log + x2go.mimebox + x2go.mimeboxactions + x2go.printactions + x2go.printqueue + x2go.pulseaudio + x2go.registry + x2go.rforward + x2go.session + x2go.sftpserver + x2go.sshproxy + x2go.telekinesis + x2go.utils + x2go.x2go_exceptions + x2go.xserver + +Module contents +--------------- + +.. automodule:: x2go + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.session.rst b/docs/source/x2go.session.rst new file mode 100644 index 0000000..2672a85 --- /dev/null +++ b/docs/source/x2go.session.rst @@ -0,0 +1,7 @@ +x2go.session module +=================== + +.. automodule:: x2go.session + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.sftpserver.rst b/docs/source/x2go.sftpserver.rst new file mode 100644 index 0000000..87c3d65 --- /dev/null +++ b/docs/source/x2go.sftpserver.rst @@ -0,0 +1,7 @@ +x2go.sftpserver module +====================== + +.. automodule:: x2go.sftpserver + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.sshproxy.rst b/docs/source/x2go.sshproxy.rst new file mode 100644 index 0000000..bbb4a24 --- /dev/null +++ b/docs/source/x2go.sshproxy.rst @@ -0,0 +1,7 @@ +x2go.sshproxy module +==================== + +.. automodule:: x2go.sshproxy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.telekinesis.rst b/docs/source/x2go.telekinesis.rst new file mode 100644 index 0000000..7bdb7b4 --- /dev/null +++ b/docs/source/x2go.telekinesis.rst @@ -0,0 +1,7 @@ +x2go.telekinesis module +======================= + +.. automodule:: x2go.telekinesis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.tests.rst b/docs/source/x2go.tests.rst new file mode 100644 index 0000000..c897457 --- /dev/null +++ b/docs/source/x2go.tests.rst @@ -0,0 +1,18 @@ +x2go.tests package +================== + +Submodules +---------- + +.. toctree:: + + x2go.tests.runalltests + x2go.tests.test_printing + +Module contents +--------------- + +.. automodule:: x2go.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.tests.runalltests.rst b/docs/source/x2go.tests.runalltests.rst new file mode 100644 index 0000000..dafa7e2 --- /dev/null +++ b/docs/source/x2go.tests.runalltests.rst @@ -0,0 +1,7 @@ +x2go.tests.runalltests module +============================= + +.. automodule:: x2go.tests.runalltests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.tests.test_printing.rst b/docs/source/x2go.tests.test_printing.rst new file mode 100644 index 0000000..a78ef8f --- /dev/null +++ b/docs/source/x2go.tests.test_printing.rst @@ -0,0 +1,7 @@ +x2go.tests.test_printing module +=============================== + +.. automodule:: x2go.tests.test_printing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.utils.rst b/docs/source/x2go.utils.rst new file mode 100644 index 0000000..a9051be --- /dev/null +++ b/docs/source/x2go.utils.rst @@ -0,0 +1,7 @@ +x2go.utils module +================= + +.. automodule:: x2go.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.x2go_exceptions.rst b/docs/source/x2go.x2go_exceptions.rst new file mode 100644 index 0000000..7de0edb --- /dev/null +++ b/docs/source/x2go.x2go_exceptions.rst @@ -0,0 +1,7 @@ +x2go.x2go_exceptions module +=========================== + +.. automodule:: x2go.x2go_exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/x2go.xserver.rst b/docs/source/x2go.xserver.rst new file mode 100644 index 0000000..a0c41dd --- /dev/null +++ b/docs/source/x2go.xserver.rst @@ -0,0 +1,7 @@ +x2go.xserver module +=================== + +.. automodule:: x2go.xserver + :members: + :undoc-members: + :show-inheritance: -- Alioth's /home/x2go-admin/maintenancescripts/git/hooks/post-receive-email on /srv/git/code.x2go.org/python-x2go.git