From cb9af3881e37b9f7df0948c0af92ee406786b775 Mon Sep 17 00:00:00 2001 From: Goffi Date: Tue, 3 Nov 2026 14:18:45 +0100 Subject: [PATCH] doc (testing): move the testing documentation to its own page: Testing is now in the "Developer" section of the index, and the `contributing/` directory is removed (redundant). --- doc/contributing/index.rst | 15 --------------- doc/developer.rst | 10 +--------- doc/index.rst | 1 + doc/{contributing => }/testing.rst | 4 ++-- 4 files changed, 4 insertions(+), 26 deletions(-) delete mode 100644 doc/contributing/index.rst rename doc/{contributing => }/testing.rst (99%) diff --git a/doc/contributing/index.rst b/doc/contributing/index.rst deleted file mode 100644 index bcbeb3b5..00000000 --- a/doc/contributing/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _contributing: - -============ -contributing -============ - -This part of the documentation is for people willing to contribute to the development of -Libervia and its ecosystem, it is not needed to read this if you only plan to use the -software. - -.. toctree:: - :glob: - :maxdepth: 2 - - testing diff --git a/doc/developer.rst b/doc/developer.rst index 0eb3bc62..9ef60842 100644 --- a/doc/developer.rst +++ b/doc/developer.rst @@ -4,7 +4,7 @@ Developer Documentation ======================= -This documentation is intended for people who wants to contribute or work with the +This documentation is intended for people who want to contribute or work with the internals of the project, it is not for end-users. Storage @@ -79,11 +79,3 @@ The Raw XML is kept as the cache operates transparently, and a plugin may need r an user may be doing a low-level pubsub request. .. _JSON: https://docs.sqlalchemy.org/en/14/core/type_basics.html#sqlalchemy.types.JSON - - -Libervia Apps -============= - -Libervia has a mechanism to embed applications and configure them to integrate with the -ecosystem. This is notably used to embed docker applications. Description of the -application description file is available at :ref:`libervia-app-config`. diff --git a/doc/index.rst b/doc/index.rst index 585ec2ab..432ca25c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -47,6 +47,7 @@ You can follow this documentation to learn more on it, or join our official XMPP :maxdepth: 2 developer.rst + testing.rst apps.rst diff --git a/doc/contributing/testing.rst b/doc/testing.rst similarity index 99% rename from doc/contributing/testing.rst rename to doc/testing.rst index 31d98efc..50d10f54 100644 --- a/doc/contributing/testing.rst +++ b/doc/testing.rst @@ -1,12 +1,12 @@ ======= -testing +Testing ======= You'll find here the documentation to run tests on Libervia. If you plan to contribute to the ecosystem, you should use them to check that your modification is not breaking anything, and if possible you should extend them to cover any new feature. -.. _contributing-overview: +.. _testing: overview ========