Skip to content

Commit

Permalink
Docs Enhancements (#279)
Browse files Browse the repository at this point in the history
* Doc: Enhanced "Jump to" section

* Doc: Enhanced "Quick Jump" section
  • Loading branch information
Nusnus authored Apr 11, 2024
1 parent 9bd9022 commit f561d2d
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/getting-started/first-steps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,8 @@ These fixtures are responsible for the setup/teardown of each node.
Built-in Components
~~~~~~~~~~~~~~~~~~~

.. _celery-worker:

Celery Worker
-------------

Expand All @@ -635,6 +637,8 @@ Fixtures

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

.. _rabbitmq-broker:

RabbitMQ Broker
---------------

Expand Down Expand Up @@ -679,6 +683,8 @@ Fixtures

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

.. _redis-backend:

Redis Backend
-------------

Expand All @@ -700,6 +706,8 @@ Fixtures

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

.. _memcached-backend:

Memcached Backend
-----------------

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

.. topic:: Jump to ⟶

.. hlist::
:columns: 4

- :ref:`Contributing <contributing>`
- :ref:`FAQ <faq>`
- :ref:`API Reference <apiref>`
- :ref:`vendors`
- :ref:`built-in-worker`
- :ref:`vendor-class`
- :ref:`test-containers`
- :ref:`test-nodes`
- :ref:`test-clusters`
- :ref:`test-setup`
- :ref:`manipulating-the-environment`
- :ref:`default-fixtures`
- :ref:`celery-application`
- :ref:`disable_backend`
- :ref:`built-in-components`
- :ref:`components-layers`
- :ref:`celery-worker`
- :ref:`rabbitmq-broker`
- :ref:`redis-broker`
- :ref:`redis-backend`
- :ref:`memcached-backend`
- :ref:`hello-world`
- :ref:`code-generation`
- :ref:`architecture-injection`
- :ref:`contributing`
- :ref:`apiref`

.. _installation:

Expand Down

0 comments on commit f561d2d

Please sign in to comment.