New Doc: Useful Resources (#251)

* Cleaned :pypi: usage

* New Doc: Useful Resources

Author: Nusnus

docs/faq.rst

@@ -140,7 +140,7 @@ Integrating with Docker
 How do I get pytest-celery to work with Docker?
 -----------------------------------------------
 
-**Answer:** The engine behind the plugin's docker integration is :pypi:`pytest-docker-tools`.
+**Answer:** The engine behind the plugin's docker integration is :pypi:`pytest-docker-tools <pytest-docker-tools>`.
 
 It does not interact with Docker directly.
 
@@ -165,7 +165,7 @@ What are the common pitfalls when integrating pytest-celery with Docker, and how
 To avoid these, you may:
 
 1. Increase the resources available to Docker.
-2. Use the :pypi:`pytest-rerunfailures` pytest plugin to retry failed tests with:
+2. Use the :pypi:`pytest-rerunfailures <pytest-rerunfailures>` pytest plugin to retry failed tests with:
 
 .. code-block:: console
 

docs/getting-started/introduction.rst

@@ -215,7 +215,7 @@ Features
 
         - **Tests as first class citizens**
 
-            The plugin is designed to enhance testing capabilities by :ref:`first-class-citizen`.
+            The plugin is designed to enhance testing capabilities by treating tests as first-class citizens.
             It uses advanced mechanisms to encapsulate the complexity of setting up a Celery environment, thus
             allowing the developer to focus on the test case itself and leave the hard lifting to the plugin.
 

docs/includes/installation.txt

@@ -16,8 +16,8 @@ This command installs **pytest-celery** along with its required dependencies.
 
 This will include:
 
-- Latest version of :pypi:`celery`.
-- RabbitMQ broker via :pypi:`kombu`, installed as a dependency of Celery.
+- Latest version of :pypi:`celery <celery>`.
+- RabbitMQ broker via :pypi:`kombu <kombu>`, installed as a dependency of Celery.
 
 Installing pytest-celery vendors
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/userguide/advanced-installation.rst

@@ -39,8 +39,8 @@ automatically add the matching components to the default setup matrix.
 
 For example, let's assume you want to use the RabbitMQ/Redis combination.
 
-1. For RabbitMQ we will need :pypi:`kombu`.
-2. For Redis we will need :pypi:`redis`.
+1. For RabbitMQ we will need :pypi:`kombu <kombu>`.
+2. For Redis we will need :pypi:`redis <redis>`.
 
 To install the plugin with the RabbitMQ/Redis combination, you will need to install the following dependencies:
 
@@ -51,7 +51,7 @@ To install the plugin with the RabbitMQ/Redis combination, you will need to inst
 Let's break down the command:
 
 - The ``pytest-celery`` is the plugin package, it will install the plugin alongside Celery and its dependencies,including **Kombu** (if not installed already).
-- The ``[redis]`` is the feature flag for the Redis vendor, it will install the :pypi:`redis` package and configure the plugin to use it which will add the Redis backend and Redis broker components to the default setup matrix.
+- The ``[redis]`` is the feature flag for the Redis vendor, it will install the :pypi:`redis <redis>` package and configure the plugin to use it which will add the Redis backend and Redis broker components to the default setup matrix.
 
 Experimental Vendors
 ~~~~~~~~~~~~~~~~~~~~

docs/userguide/examples/hybrid_setup.rst

@@ -37,7 +37,7 @@ Highlights
 
 1. No default components.
 2. Session broker and backend components.
-    - Shared between tests, but not between :pypi:`pytest-xdist` sessions.
+    - Shared between tests, but not between :pypi:`pytest-xdist <pytest-xdist>` sessions.
     - Only the workers are created again for each test case.
 3. Injects tasks and signal handlers modules to all workers.
 
@@ -83,7 +83,7 @@ Take a look at the requirements file for this example:
     :language: text
     :caption: examples.hybrid_setup.requirements.txt
 
-Take note the :pypi:`gevent` can be installed independently from the :pypi:`celery` package.
+Take note the :pypi:`gevent <gevent>` can be installed independently from the :pypi:`celery <celery>` package.
 
 conftest.py
 ~~~~~~~~~~~

docs/userguide/resources/first-class-citizen.rst

@@ -7,7 +7,18 @@
 :Release: |version|
 :Date: |today|
 
-.. toctree::
-    :maxdepth: 1
+This section contains additional resources that may be useful when developing tests with :pypi:`pytest <pytest>`,
+:pypi:`pytest-celery <pytest-celery>`, and general :pypi:`celery <celery>` related testing articles, guides and tutorials.
 
-    first-class-citizen
+**You're welcome to contribute to this list!**
+
+.. contents::
+    :local:
+    :depth: 2
+
+Other Plugins
+~~~~~~~~~~~~~
+
+- :pypi:`pytest-rerunfailures <pytest-rerunfailures>`: Do to the natural sensitivity of simulating Celery environments over Docker, it's
+  common to have flaky tests due to failing docker resources. This plugin provide useful features to rerun failed tests, skipping tests that
+  failed due to actual assertion errors.