annotate doc/index.rst @ 353:19422bbd9c8e

core (widgets handler): refactoring: - CagouWidget now has class properties (to be overridden when needed) which indicate how if the widget handle must add a wrapping ScreenManager (global_screen_manager) or show all instances of the class in a Carousel (collection_carousel). If none of those options is used, a ScrollView will be wrapping the widget, to be sure that the widget will be resized correctly when necessary (without it, the widget could still be drawn in the backround when the size is too small and overflow on the WidgetWrapper, this would be the case with WidgetSelector) - some helper methods/properties have been added to CagouWidget. Check docstrings for details - better handling of (in)visible widget in WidgetsHandler - thanks to the new wrapping ScrollView, WidgetSelect will show scroll bars if the available space is too small. - bugs fixes
author Goffi <goffi@goffi.org>
date Fri, 17 Jan 2020 18:44:35 +0100
parents aafd814e34b5
children 383b5f54aba9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
307
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
1 .. Cagou (Salut à Toi) documentation master file, created by
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
2 sphinx-quickstart on Tue Jul 23 20:07:36 2019.
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
3 You can adapt this file completely to your liking, but it should at least
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
4 contain the root `toctree` directive.
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
5
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
6 Cagou (Salut à Toi) documentation
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
7 =================================
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
8
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
9 Welcome to Cagou's documentation. You'll find here both end-user end developer documentations.
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
10
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
11 Cagou is the desktop/mobile frontend of Salut à Toi (or SàT), a Libre communication ecosystem based on XMPP standard.
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
12
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
13 You can follow this documentation to learn more on it, or join our official XMPP room at `sat@chat.jabberfr.org <xmpp:sat@chat.jabberfr.org?join>`_ (also available via a `web link <https://chat.jabberfr.org/converse.js/sat@chat.jabberfr.org>`_)
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
14
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
15
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
16 .. toctree::
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
17 :maxdepth: 3
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
18 :caption: Contents:
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
19
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
20 installation.rst
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
21
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
22
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
23
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
24 Indices and tables
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
25 ==================
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
26
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
27 * :ref:`genindex`
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
28
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
29 ..
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
30 * :ref:`modindex`
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
31
aafd814e34b5 doc: first draft
Goffi <goffi@goffi.org>
parents:
diff changeset
32 * :ref:`search`