From c63e4627ec0613f7fcc6d9a936c14a64a2655b33 Mon Sep 17 00:00:00 2001 From: Jonathan Weth Date: Mon, 27 Jul 2020 15:31:27 +0200 Subject: Add documentation --- docs/Makefile | 19 ++++ docs/admin/00_index.rst | 7 ++ docs/admin/01_installation.rst | 45 ++++++++++ docs/admin/02_config.rst | 4 + docs/admin/03_testing.rst | 24 ++++++ docs/conf.py | 191 +++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 21 +++++ docs/make.bat | 35 ++++++++ docs/ref/00_index.rst | 7 ++ docs/ref/01_dbus.rst | 5 ++ 10 files changed, 358 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/admin/00_index.rst create mode 100644 docs/admin/01_installation.rst create mode 100644 docs/admin/02_config.rst create mode 100644 docs/admin/03_testing.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100755 docs/make.bat create mode 100644 docs/ref/00_index.rst create mode 100644 docs/ref/01_dbus.rst (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..5128596 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/admin/00_index.rst b/docs/admin/00_index.rst new file mode 100644 index 0000000..a5587b8 --- /dev/null +++ b/docs/admin/00_index.rst @@ -0,0 +1,7 @@ +Installation and configuration +============================== + +.. toctree:: + :glob: + + * diff --git a/docs/admin/01_installation.rst b/docs/admin/01_installation.rst new file mode 100644 index 0000000..064cce9 --- /dev/null +++ b/docs/admin/01_installation.rst @@ -0,0 +1,45 @@ +Installation +============ + +We recommend to use Debian-based systems for first tests. +Later there will be supported more operating systems, +but for now you should start with a Debian-like system. + +As a first step use ``apt`` to install the core dependencies as debian packages: + +:: + + sudo apt install python3 python3-venv python3-pip x11vnc libcairo2-dev libdbus-glib-1-dev libgirepository1.0-dev wget + +To bundle the further dependencies of the D-Bus daemon, +we use Poetry to get them from the PyPI. So, install Poetry using PIP: + +:: + + sudo pip3 install poetry + +Then use poetry to get all packages from PyPI necessary for running the service +(be sure that you are in the source code directory): + +:: + + poetry install + + +Now you can continue with :doc:`02_config`. + +.. warning:: + + As Poetry also manages your virtual environment, you must use + ``poetry run`` everytime if you want to start something in your environment: + + **Example:** + + :: + + poetry run python test_client.py + + # or + + poetry run python tox + diff --git a/docs/admin/02_config.rst b/docs/admin/02_config.rst new file mode 100644 index 0000000..8666afa --- /dev/null +++ b/docs/admin/02_config.rst @@ -0,0 +1,4 @@ +Configuration +============= + +TBA. \ No newline at end of file diff --git a/docs/admin/03_testing.rst b/docs/admin/03_testing.rst new file mode 100644 index 0000000..ab427bc --- /dev/null +++ b/docs/admin/03_testing.rst @@ -0,0 +1,24 @@ +Test your installation +====================== + +To ensure that your D-Bus daemon is installed and configured correctly +and can work with the RWA server, +you can use the test client provided in the Session Service package: + + +Firstly, start the D-Bus daemon in foreground (e. g. in a second terminal), +so the client can interact with it: + + +:: + + poetry run python service.py + +Now you can use the test client to start a test session +and register it in your RWA server. It will return a PIN and +a URL in JSON which you can use to connect to the remote session +in the web browser: + +:: + + poetry run python test_client.py \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..af26730 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +import os +import sys + +# 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. +# + +sys.path.insert(0, os.path.abspath("..")) +#os.environ["DJANGO_SETTINGS_MODULE"] = "aleksis.core.settings" +#os.environ["LOCAL_SETTINGS_FILE"] = os.path.abspath(os.path.join("..", "local.cfg")) +#django.setup() + +# -- Project information ----------------------------------------------------- + +project = "RWA Session Service" +copyright = "2020, RWA team" +author = "RWA team" + +# The short X.Y version +version = "1.0" +# The full version, including alpha/beta/rc tags +release = "1.0" + + +# -- 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_autodoc_typehints", + "sphinx.ext.intersphinx", + "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 master toctree document. +master_doc = "index" + +# 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 = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- 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 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"] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = "RWAdoc" + + +# -- 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, "AlekSIS.tex", "RWA Session Service Documentation", "RWA team", "manual"), +] + + +# -- 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, "aleksis", "RWA Session Service Documentation", [author], 1)] + + +# -- 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, + "RWA Session Service", + "RWA Session Service Documentation", + author, + "AlekSIS", + "One line description of project.", + "Miscellaneous", + ), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# 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 list of files that should not be packed into the epub file. +epub_exclude_files = ["search.html"] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "https://docs.python.org/": None, + "https://docs.djangoproject.com/en/stable": "https://docs.djangoproject.com/en/stable/_objects", +} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7eac2b6 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +Welcome to RWA’s Session Service documentation! +=============================================== + +The RWA Session Service is a D-Bus daemon for use in the RWA +(Remote Web App) system. It should be used as +backend for client applications which provide remote control via RWA. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + admin/00_index + ref/00_index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100755 index 0000000..7893348 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/ref/00_index.rst b/docs/ref/00_index.rst new file mode 100644 index 0000000..80d1272 --- /dev/null +++ b/docs/ref/00_index.rst @@ -0,0 +1,7 @@ +API +=== + +.. toctree:: + :glob: + + * diff --git a/docs/ref/01_dbus.rst b/docs/ref/01_dbus.rst new file mode 100644 index 0000000..4b69353 --- /dev/null +++ b/docs/ref/01_dbus.rst @@ -0,0 +1,5 @@ +D-Bus service +============= + +.. autoclass:: service.RWAService + :members: \ No newline at end of file -- cgit v1.2.3