annotate doc/index.rst @ 1417:314bba1ae433

pages: breadcrumbs handling: a new `breadcrumbs` list of dict is created in `template_data`. By default it is automatically filled by pages run to reach the requested URI, but a page can customize it. A breadcrumb data dict must have a `label`, should have an `url` and may have an `icon` (which is the name of a SàT Media well-known icon). Pages may now have a `label` attribute, which is used to automatically fill the crumb (otherwise page name then URI is used). A new `add_breadcrumb` method can be used to manually breadcrumb data, in which case auto-filling is disabled.
author Goffi <goffi@goffi.org>
date Thu, 29 Apr 2021 20:48:35 +0200
parents 83b477d36725
children fe5c282461bd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1190
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
1 .. Libervia (Salut à Toi) documentation master file, created by
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
2 sphinx-quickstart on Thu Jan 24 15:20:15 2019.
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
3 You can adapt this file completely to your liking, but it should at least
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
4 contain the root `toctree` directive.
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
5
1409
83b477d36725 doc: rename main title
Goffi <goffi@goffi.org>
parents: 1209
diff changeset
6 Libervia Web documentation
83b477d36725 doc: rename main title
Goffi <goffi@goffi.org>
parents: 1209
diff changeset
7 ==========================
1190
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
8
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
9 Welcome to Libervia's documentation. You'll find here both end-user end developer documentations.
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
10
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
11 Libervia is the web frontend of Salut à Toi (or SàT), a Libre communication ecosystem based on XMPP standard.
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
12
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
13 With Libervia you have access to main SàT features thanks to its easy to use pages.
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
14 It is a highly customizable project, the interface can be modified from slight to major changes, so it can be adapted to your association, university, entreprise or community.
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
15
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
16 Libervia includes its own web framework, using a unique architecture taking profit of the XMPP standard.
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
17
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
18 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>`_)
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
19
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
20 .. toctree::
1209
13447f785ba1 doc: added installation instructions
Goffi <goffi@goffi.org>
parents: 1190
diff changeset
21 :maxdepth: 3
1190
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
22 :caption: Contents:
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
23
1209
13447f785ba1 doc: added installation instructions
Goffi <goffi@goffi.org>
parents: 1190
diff changeset
24 installation.rst
1190
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
25 web_framework/quick_start.rst
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
26 web_framework/css_framework.rst
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
27
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
28
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
29
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
30 Indices and tables
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
31 ==================
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
32
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
33 * :ref:`genindex`
1209
13447f785ba1 doc: added installation instructions
Goffi <goffi@goffi.org>
parents: 1190
diff changeset
34
1190
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
35 ..
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
36 * :ref:`modindex`
1209
13447f785ba1 doc: added installation instructions
Goffi <goffi@goffi.org>
parents: 1190
diff changeset
37
1190
b9a5418e9f2e doc: added forgotten conf.py and index.rst files
Goffi <goffi@goffi.org>
parents:
diff changeset
38 * :ref:`search`