erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactoring: fix names in doc following modules hierarchy refactoring

Browse source
This commit is contained in:
Goffi 2023-06-02 17:38:37 +02:00
commit 7e3834a5e9
9 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/components.rst
View file

@ -384,7 +384,7 @@ like this:
The encoding is explained in the documentation of the following method:
.. automethod:: sat.plugins.plugin_comp_ap_gateway.APGateway.get_jid_and_node
.. automethod:: libervia.backend.plugins.plugin_comp_ap_gateway.APGateway.get_jid_and_node
.. [#AP_chars] Most if not all AP implementations use webfinger `acct` URI as a de-facto
@ -862,7 +862,7 @@ Publication of AP items can be tested using the following method (with can be ac
through the ``ap_send`` bridge method, client is then replaced by the ``profile`` name, as
last argument):
.. automethod:: sat.plugins.plugin_comp_ap_gateway.APGateway.publish_message
.. automethod:: libervia.backend.plugins.plugin_comp_ap_gateway.APGateway.publish_message
The method can be used either with CLI's :ref:`debug bridge method
<li_debug_bridge_method>` or with any D-Bus tool like ``qdbus`` or ``d-feet`` (only if you

6
doc/conf.py
View file

@ -23,12 +23,12 @@ sys.path.insert(0, os.path.abspath("./_ext"))
# -- Project information -----------------------------------------------------
project = 'Libervia'
copyright = '2019-2021 Libervia'
project = 'Libervia Backend'
copyright = '2019-2023 Libervia'
author = 'Libervia team'
doc_dir = os.path.dirname(os.path.abspath(__file__))
version_path = os.path.join(doc_dir, '../sat/VERSION')
version_path = os.path.join(doc_dir, '../libervia/backend/VERSION')
with open(version_path) as f:
version_full = f.read()

2
doc/configuration.rst
View file

@ -118,7 +118,7 @@ the comments to get the meaning of each option.
[plugin muc]
; default room to use in the "Join room" menu
default_muc = sat@chat.jabberfr.org
default_muc = libervia@chat.jabberfr.org
[tui]
log_level = debug

2
doc/contributing/testing.rst
View file

@ -12,7 +12,7 @@ overview
========
Tests are run using `pytest`_ and are located in the ``tests`` directory.
You'll also find legacy tests in ``sat/test`` but those one are old, not maintained and
You'll also find legacy tests in ``libervia/backend/test`` but those one are old, not maintained and
only kept there temporarily until they are ported to the new system.
For now, emphasis is put on end-2-end tests, as they are covering the whole ecosystem, and

10
doc/developer.rst
View file

@ -17,12 +17,12 @@ migrations.
SQLite_ is currently the only supported database, but it is planned to add support for
other ones (notably PostgreSQL), probably during the development of 0.9 version.
The mapping is done in ``sat.memory.sqla_mapping`` and working with database is done
through high level methods found in ``sat.memory.sqla``.
The mapping is done in ``libervia.backend.memory.sqla_mapping`` and working with database is done
through high level methods found in ``libervia.backend.memory.sqla``.
Before the move to SQLAlchemy, there was a strict separation between database
implementation and the rest of the code. With 0.9, objects mapping to database can be used
and manipulated directly outside of ``sat.memory.sqla`` to take profit of SQLAlchemy
and manipulated directly outside of ``libervia.backend.memory.sqla`` to take profit of SQLAlchemy
possibilities.
Database state is detected when the backend starts, and the database will be created or
@ -31,7 +31,7 @@ migrated automatically if necessary.
To create a new migration script, ``Alembic`` may be used directly. To do so, be sure to
have an up-to-date database (and a backup in case of troubles), then activate the virtual
environment where Libervia is installed (Alembic needs to access ORM mapping), go to
``sat/memory/migration`` directory, and enter the following command::
``libervia/backend/memory/migration`` directory, and enter the following command::
alembic revision --autogenerate -m "some revision message"
@ -62,7 +62,7 @@ synchronised or not.
Analysers can be registered by any plugins using ``register_analyser`` method:
.. automethod:: sat.plugins.plugin_pubsub_cache.PubsubCache.register_analyser
.. automethod:: libervia.backend.plugins.plugin_pubsub_cache.PubsubCache.register_analyser
If no analyser is found, ``to_sync`` is false, or an error happens during the caching,
the node won't be synchronised and the pubsub service will always be requested.

2
doc/index.rst
View file

@ -16,7 +16,7 @@ Libervia is a Libre communication ecosystem based on XMPP standard. It allows yo
It features many interfaces (desktop, mobile, web, command line, console), and is multi-platforms.
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>`_)
You can follow this documentation to learn more on it, or join our official XMPP room at `libervia@chat.jabberfr.org <xmpp:libervia@chat.jabberfr.org?join>`_ (also available via a `web link <https://chat.jabberfr.org/converse.js/libervia@chat.jabberfr.org>`_)
.. toctree::

2
doc/libervia-cli/bookmarks.rst
View file

@ -91,7 +91,7 @@ examples
Add a bookmark to Libervia official chat room::
$ li bookmarks add sat@chat.jabberfr.org -a
$ li bookmarks add libervia@chat.jabberfr.org -a
Add a link to Libervia official website::

2
doc/libervia-cli/event.rst
View file

@ -38,7 +38,7 @@ RSVP form which ask for attendance. If you want to request more information to y
``data_dict_2_data_form`` function where the ``namespace`` key is not necessary (it's set
automatically):
.. autofunction:: sat.tools.xml_tools.data_dict_2_data_form
.. autofunction:: libervia.backend.tools.xml_tools.data_dict_2_data_form
If the event links to an other one, ``--external JID NODE ITEM`` can be user

4
doc/libervia-cli/message.rst
View file

@ -89,8 +89,8 @@ Retrieve messages from last 2 days::
Retrieve messages from last 5 hours on Libervia official chat room::
$ li message mam -S "5 hours ago" -s sat@chat.jabberfr.org
$ li message mam -S "5 hours ago" -s libervia@chat.jabberfr.org
Retrieve 2 first messages of 2019 on Libervia official chat room::
$ li message mam -S 2019-01-01 -s sat@chat.jabberfr.org -m 2
$ li message mam -S 2019-01-01 -s libervia@chat.jabberfr.org -m 2