From 7e3834a5e95da5cdeb2d6e3c805b32c5af04219e Mon Sep 17 00:00:00 2001 From: Goffi Date: Fri, 2 Jun 2023 17:38:37 +0200 Subject: [PATCH] refactoring: fix names in doc following modules hierarchy refactoring --- doc/components.rst | 4 ++-- doc/conf.py | 6 +++--- doc/configuration.rst | 2 +- doc/contributing/testing.rst | 2 +- doc/developer.rst | 10 +++++----- doc/index.rst | 2 +- doc/libervia-cli/bookmarks.rst | 2 +- doc/libervia-cli/event.rst | 2 +- doc/libervia-cli/message.rst | 4 ++-- 9 files changed, 17 insertions(+), 17 deletions(-) diff --git a/doc/components.rst b/doc/components.rst index 64bd7951..739b80ea 100644 --- a/doc/components.rst +++ b/doc/components.rst @@ -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 ` or with any D-Bus tool like ``qdbus`` or ``d-feet`` (only if you diff --git a/doc/conf.py b/doc/conf.py index 7ec42173..1dfd0245 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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() diff --git a/doc/configuration.rst b/doc/configuration.rst index 2bee0ed3..c2cd550d 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -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 diff --git a/doc/contributing/testing.rst b/doc/contributing/testing.rst index f8698aef..f461095b 100644 --- a/doc/contributing/testing.rst +++ b/doc/contributing/testing.rst @@ -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 diff --git a/doc/developer.rst b/doc/developer.rst index f53cbf2e..93943334 100644 --- a/doc/developer.rst +++ b/doc/developer.rst @@ -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. diff --git a/doc/index.rst b/doc/index.rst index 13550572..5e008369 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 `_ (also available via a `web link `_) +You can follow this documentation to learn more on it, or join our official XMPP room at `libervia@chat.jabberfr.org `_ (also available via a `web link `_) .. toctree:: diff --git a/doc/libervia-cli/bookmarks.rst b/doc/libervia-cli/bookmarks.rst index 439eddb8..8a4aca79 100644 --- a/doc/libervia-cli/bookmarks.rst +++ b/doc/libervia-cli/bookmarks.rst @@ -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:: diff --git a/doc/libervia-cli/event.rst b/doc/libervia-cli/event.rst index d3657588..fa552a3f 100644 --- a/doc/libervia-cli/event.rst +++ b/doc/libervia-cli/event.rst @@ -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 diff --git a/doc/libervia-cli/message.rst b/doc/libervia-cli/message.rst index 242080eb..03b956f0 100644 --- a/doc/libervia-cli/message.rst +++ b/doc/libervia-cli/message.rst @@ -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