changeset 4077:d6837db456fd

refactoring: fix names in doc following modules hierarchy refactoring
author Goffi <goffi@goffi.org>
date Fri, 02 Jun 2023 17:38:37 +0200
parents b620a8e882e1
children 15055a00162c
files doc/components.rst doc/conf.py doc/configuration.rst doc/contributing/testing.rst doc/developer.rst doc/index.rst doc/libervia-cli/bookmarks.rst doc/libervia-cli/event.rst doc/libervia-cli/message.rst
diffstat 9 files changed, 17 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/doc/components.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/components.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -384,7 +384,7 @@
 
 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 @@
 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
--- a/doc/conf.py	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/conf.py	Fri Jun 02 17:38:37 2023 +0200
@@ -23,12 +23,12 @@
 
 # -- 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()
 
--- a/doc/configuration.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/configuration.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -118,7 +118,7 @@
 
     [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
--- a/doc/contributing/testing.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/contributing/testing.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -12,7 +12,7 @@
 ========
 
 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
--- a/doc/developer.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/developer.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -17,12 +17,12 @@
 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 @@
 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 @@
 
 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.
--- a/doc/index.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/index.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -16,7 +16,7 @@
 
 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::
--- a/doc/libervia-cli/bookmarks.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/libervia-cli/bookmarks.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -91,7 +91,7 @@
 
 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::
 
--- a/doc/libervia-cli/event.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/libervia-cli/event.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -38,7 +38,7 @@
 ``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
 
--- a/doc/libervia-cli/message.rst	Fri Jun 02 16:25:25 2023 +0200
+++ b/doc/libervia-cli/message.rst	Fri Jun 02 17:38:37 2023 +0200
@@ -89,8 +89,8 @@
 
 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