Skip to content

Commit f561d2d

Browse files
authored
Docs Enhancements (#279)
* Doc: Enhanced "Jump to" section * Doc: Enhanced "Quick Jump" section
1 parent 9bd9022 commit f561d2d

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

docs/getting-started/first-steps.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -613,6 +613,8 @@ These fixtures are responsible for the setup/teardown of each node.
613613
Built-in Components
614614
~~~~~~~~~~~~~~~~~~~
615615

616+
.. _celery-worker:
617+
616618
Celery Worker
617619
-------------
618620

@@ -635,6 +637,8 @@ Fixtures
635637

636638
A list of available fixtures for the worker can be found in the :mod:`pytest_celery.vendors.worker.fixtures` module.
637639

640+
.. _rabbitmq-broker:
641+
638642
RabbitMQ Broker
639643
---------------
640644

@@ -679,6 +683,8 @@ Fixtures
679683

680684
A list of available fixtures for the broker can be found in the :mod:`pytest_celery.vendors.redis.broker.fixtures` module.
681685

686+
.. _redis-backend:
687+
682688
Redis Backend
683689
-------------
684690

@@ -700,6 +706,8 @@ Fixtures
700706

701707
A list of available fixtures for the backend can be found in the :mod:`pytest_celery.vendors.redis.backend.fixtures` module.
702708

709+
.. _memcached-backend:
710+
703711
Memcached Backend
704712
-----------------
705713

docs/getting-started/introduction.rst

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,15 +244,39 @@ Quick Jump
244244
- `To see production examples <https://github.com/celery/celery/tree/main/t/smoke/>`_.
245245
- `To learn more about pytest <https://docs.pytest.org/en/latest/getting-started.html>`_.
246246
- `To learn more about Celery <https://docs.celeryproject.org/en/stable/getting-started/introduction.html>`_.
247+
- :ref:`To create a standalone Celery bug report with pytest-celery <celery-bug-report>`
248+
- :ref:`To copy a simple project for bootstrapping <examples_myworker>`.
249+
- :ref:`To see an example that uses different celery workers at the same time <examples_hybrid_setup>`
247250

248251
.. topic:: Jump to ⟶
249252

250253
.. hlist::
251254
:columns: 4
252255

253-
- :ref:`Contributing <contributing>`
254256
- :ref:`FAQ <faq>`
255-
- :ref:`API Reference <apiref>`
257+
- :ref:`vendors`
258+
- :ref:`built-in-worker`
259+
- :ref:`vendor-class`
260+
- :ref:`test-containers`
261+
- :ref:`test-nodes`
262+
- :ref:`test-clusters`
263+
- :ref:`test-setup`
264+
- :ref:`manipulating-the-environment`
265+
- :ref:`default-fixtures`
266+
- :ref:`celery-application`
267+
- :ref:`disable_backend`
268+
- :ref:`built-in-components`
269+
- :ref:`components-layers`
270+
- :ref:`celery-worker`
271+
- :ref:`rabbitmq-broker`
272+
- :ref:`redis-broker`
273+
- :ref:`redis-backend`
274+
- :ref:`memcached-backend`
275+
- :ref:`hello-world`
276+
- :ref:`code-generation`
277+
- :ref:`architecture-injection`
278+
- :ref:`contributing`
279+
- :ref:`apiref`
256280

257281
.. _installation:
258282

0 commit comments

Comments
 (0)