Skip to content

Commit dcb4af5

Browse files
authored
New Doc: docs/getting-started/next-steps.rst (#190)
1 parent 822c338 commit dcb4af5

File tree

5 files changed

+347
-13
lines changed

5 files changed

+347
-13
lines changed

docs/getting-started/first-steps.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ for the same component, and the test environment will continue to function as ex
9494
Under this principle, the test environment is designed to be flexible and extensible, allowing the user to
9595
easily replace any component with a custom implementation.
9696

97+
.. _test-clusters:
98+
9799
Test Clusters
98100
-------------
99101

@@ -364,6 +366,8 @@ These fixtures will generate a cluster with a single Celery worker node, based o
364366
1. :func:`celery_worker <pytest_celery.fixtures.worker.celery_worker>`: Latest Celery worker node.
365367
2. :func:`celery_worker_cluster <pytest_celery.fixtures.worker.celery_worker_cluster>`: Single worker cluster for ``celery_worker``.
366368

369+
.. _celery-application:
370+
367371
Celery Application
368372
-------------------
369373

@@ -444,7 +448,7 @@ For handlers inside the test, you can use the standard API, for example.
444448

445449
.. code-block:: python
446450
447-
from celery.signals import after_task_publish
451+
from celery.signals import before_task_publish
448452
449453
def test_before_task_publish(celery_setup: CeleryTestSetup):
450454
@before_task_publish.connect
@@ -533,6 +537,8 @@ Let's have a quick recap over what we just learned in this section then.
533537
* - **Setup Matrix**
534538
- The :func:`celery_setup <pytest_celery.fixtures.setup.celery_setup>` will generate a matrix of isolated environments for each test case, based on the enabled components and their configurations.
535539

540+
.. _built-in-components:
541+
536542
Using the built-in components
537543
=============================
538544

@@ -548,6 +554,8 @@ or entirely replaced by a set of components specific to the target project.
548554
Make the most straightforward setup for a test case to avoid over-engineering the test environment.
549555
Reconfiguring the existing components is very powerful and should be the first step in most cases.
550556

557+
.. _components-layers:
558+
551559
Components Layers
552560
~~~~~~~~~~~~~~~~~
553561

@@ -738,6 +746,8 @@ Key takeaways from this section.
738746
* - **Extensible Design**
739747
- Most of the configurations can be overridden or extended to bootstrap the environment for the target project.
740748

749+
.. _hello-world:
750+
741751
Hello, World!
742752
=============
743753

docs/getting-started/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ Features
182182
- **Architecture Injection**
183183

184184
By default, a set of predefined components is used to build the Celery architecture for each test.
185-
Each built-in component can be either configured or replaced with a custom replacement.
185+
Each built-in component can be either configured or completely replaced with a custom implementation.
186186

187187
:ref:`architecture-injection` can be done at different layers, and can be used to
188188
replace only specific elements of the architecture pipeline, or to replace the entire pipeline altogether.

0 commit comments

Comments
 (0)