# HG changeset patch # User Goffi # Date 1563905318 -7200 # Node ID aafd814e34b51f372792e485259d4cad745edf49 # Parent e2afbec1d1784d6418ee3268b683ee06849804e9 doc: first draft diff -r e2afbec1d178 -r aafd814e34b5 doc/Makefile --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/Makefile Tue Jul 23 20:08:38 2019 +0200 @@ -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) \ No newline at end of file diff -r e2afbec1d178 -r aafd814e34b5 doc/conf.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/conf.py Tue Jul 23 20:08:38 2019 +0200 @@ -0,0 +1,173 @@ +# -*- 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 -------------------------------------------------------------- + +# 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('.')) + + +# -- Project information ----------------------------------------------------- + +project = u'Cagou (Salut à Toi)' +copyright = u'2019, Jérôme Poisson' +author = u'Jérôme Poisson' + +# The short X.Y version +version = u'' +# The full version, including alpha/beta/rc tags +release = u'0.7' + + +# -- 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 = [ +] + +# 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 = [u'.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 = 'CagouSalutToidoc' + + +# -- 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, 'CagouSalutToi.tex', u'Cagou (Salut à Toi) Documentation', + u'Jérôme Poisson', '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, 'cagousaluttoi', u'Cagou (Salut à Toi) 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, 'CagouSalutToi', u'Cagou (Salut à Toi) Documentation', + author, 'CagouSalutToi', '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'] diff -r e2afbec1d178 -r aafd814e34b5 doc/index.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/index.rst Tue Jul 23 20:08:38 2019 +0200 @@ -0,0 +1,32 @@ +.. Cagou (Salut à Toi) documentation master file, created by + sphinx-quickstart on Tue Jul 23 20:07:36 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Cagou (Salut à Toi) documentation +================================= + +Welcome to Cagou's documentation. You'll find here both end-user end developer documentations. + +Cagou is the desktop/mobile frontend of Salut à Toi (or SàT), a Libre communication ecosystem based on XMPP standard. + +You can follow this documentation to learn more on it, or join our official XMPP room at `sat@chat.jabberfr.org `_ (also available via a `web link `_) + + +.. toctree:: + :maxdepth: 3 + :caption: Contents: + + installation.rst + + + +Indices and tables +================== + +* :ref:`genindex` + +.. + * :ref:`modindex` + +* :ref:`search` diff -r e2afbec1d178 -r aafd814e34b5 doc/installation.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/installation.rst Tue Jul 23 20:08:38 2019 +0200 @@ -0,0 +1,78 @@ +============ +Installation +============ + +This are the instructions to install Cagou (SàT) using Python. +Note that if you are using GNU/Linux, Cagou may already be present on your distribution. + +Cagou is a Salut à Toi frontend, the SàT backend must be installed first (if you +haven't installed it yet, it will be downloaded automatically as it is a dependency of +Cagou). Cagou and SàT backend must always have the same version. + +We recommend to use development version for now, until the release of 0.7 version which +will be "general public" version. + +Also note that Cagou as all SàT ecosystem is still using Python 2 (this will change for +0.8 version which will be Python 3 only), so all instructions below have to be made using +python 2. + +Development Version +------------------- + +*Note for Arch users: a pkgbuild is available for your distribution on +AUR, check sat-cagou-hg (as well as other sat-\* packages).* + +You can install the latest development version using pip. Please check backend documentation +to see the system dependencies needed. + +You can use the same virtual environment as the one used for installing the backend. If +you haven't installed it yet, just select a location when you want to install it, for +instance your home directory:: + + $ cd + +And enter the following commands (note that *virtualenv2* may be named +*virtualenv* on some distributions, just be sure it's Python **2** version):: + + $ virtualenv2 env + $ source env/bin/activate + $ pip install hg+https://repos.goffi.org/cagou + +If you haven't done it for the backend, you need to install the media:: + + $ cd + $ hg clone https://repos.goffi.org/sat_media + +Usage +===== + +To launch Cagou enter:: + + $ cagou + +If you want to connect directly a profile:: + + $ cagou -p profile_name + +Once started, you can use ``F11`` to switch fullscreen mode. + +You can show/hide the menu with ``ALT + M`` and show/hide the notification bar with ``ALT + N``. + +In Cagou, notifications appear on the top of the screen, in the *notification bar*. They +appear for a few seconds, but you can click on the left Cagou icon to see them entirely +and take your time to read them. + +There is no focus stealing pop-up in Cagou, when some event requires a user action, a Cagou +icon will appear on the right of notification bar, so user can click and interact with it +when it is suitable. + +Cagou has a concept of **activities**. An activity is some kind of communication tool +(chat, file sharing, remote control, etc.). On top left of each activity you have an icon +representing the activity selected. Click on it to select something else. + +You may have noticed the 3 small dots on top and left border of each activity. You can +click (or touch) them, and drag to the bottom or right to create a new activity. This way +you can do several things on the same screen (e.g. check several chat rooms, or use the +file sharing and the chat at the same time). To close this extra activity, click again on +the 3 dots and drag in the opposite direction until the top or left line become red, then +release your mouse. diff -r e2afbec1d178 -r aafd814e34b5 doc/make.bat --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/make.bat Tue Jul 23 20:08:38 2019 +0200 @@ -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