Skip to content

Commit 1757a77

Browse files
authored
Doc: Removed "Documentation under construction!" (#280)
* Doc: Removed "Documentation under construction!" * Doc: Renamed "Pytest Celery" to "pytest-celery" all over
1 parent f561d2d commit 1757a77

File tree

6 files changed

+34
-24
lines changed

6 files changed

+34
-24
lines changed

.github/ISSUE_TEMPLATE/Bug-Report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug Report
3-
about: Is something wrong with Pytest Celery?
3+
about: Is something wrong with pytest-celery?
44
title: ''
55
labels: 'bug'
66
assignees: ''
@@ -16,7 +16,7 @@ bug reports which are incomplete.
1616
<!--
1717
To check an item on the list replace [ ] with [x].
1818
-->
19-
- [ ] I have verified that the issue exists against the `main` branch of Pytest Celery.
19+
- [ ] I have verified that the issue exists against the `main` branch of pytest-celery.
2020
- [ ] This has already been asked to the [discussions forum](https://github.com/celery/pytest-celery/discussions) first.
2121
- [ ] I have checked the [issues list](https://github.com/celery/pytest-celery/issues?q=is%3Aissue+label%3A%22bug%22+-label%3A%22documentation%22)
2222
for similar or identical bug reports.

CONTRIBUTING.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Be considerate
4141
Your work will be used by other people, and you in turn will depend on the
4242
work of others. Any decision you take will affect users and colleagues, and
4343
we expect you to take those consequences into account when making decisions.
44-
Even if it's not obvious at the time, our contributions to Pytest Celery will
44+
Even if it's not obvious at the time, our contributions to pytest-celery will
4545
impact the work of others. For example, changes to code, infrastructure, policy,
4646
documentation and translations during a release may negatively impact others' work.
4747

@@ -61,9 +61,9 @@ users of Celery.
6161
Be collaborative
6262
----------------
6363

64-
Collaboration is central to Pytest Celery and to the larger free software community.
64+
Collaboration is central to pytest-celery and to the larger free software community.
6565
We should always be open to collaboration. Your work should be done
66-
transparently and patches from Pytest Celery should be given back to the community
66+
transparently and patches from pytest-celery should be given back to the community
6767
when they're made, not just when the distribution releases. If you wish
6868
to work on new code for existing upstream projects, at least keep those
6969
projects informed of your ideas and progress. It many not be possible to

CONTRIBUTORS.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The contributor proposes to grant a license for specific software (referred to as a "Contribution" or multiple "Contributions") to Pytest Celery. In turn, Pytest Celery agrees to accept these Contributions under the conditions outlined in the BSD open source license.
2-
The contributor acknowledges and consents to Pytest Celery having the irreversible and enduring right to produce and share copies of any Contribution.
3-
Additionally, Pytest Celery has the authority to generate and distribute collective works and derivative works based on any Contribution, all within the framework of the BSD License.
1+
The contributor proposes to grant a license for specific software (referred to as a "Contribution" or multiple "Contributions") to pytest-celery. In turn, pytest-celery agrees to accept these Contributions under the conditions outlined in the BSD open source license.
2+
The contributor acknowledges and consents to pytest-celery having the irreversible and enduring right to produce and share copies of any Contribution.
3+
Additionally, pytest-celery has the authority to generate and distribute collective works and derivative works based on any Contribution, all within the framework of the BSD License.
44

55
Contributors
66
------------

docs/copyright.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Copyright
44
=========
55

6-
*Pytest Celery User Manual*
6+
*pytest-celery User Manual*
77

88
by Tomer Nosrati
99

@@ -23,7 +23,7 @@ compatible license to this one.
2323

2424
.. note::
2525

26-
While the *Pytest Celery* documentation is offered under the
26+
While the *pytest-celery* documentation is offered under the
2727
Creative Commons *Attribution-ShareAlike 4.0 International* license,
28-
the Pytest Celery *software* is offered under the
28+
the pytest-celery *software* is offered under the
2929
`BSD License (3 Clause) <http://www.opensource.org/licenses/BSD-3-Clause>`_.

docs/getting-started/introduction.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _getting-started_intro:
22

33
===============================
4-
Introduction to Pytest Celery
4+
Introduction to pytest-celery
55
===============================
66

77
:Release: |version|
@@ -11,7 +11,7 @@
1111
:local:
1212
:depth: 2
1313

14-
What is Pytest Celery?
14+
What is pytest-celery?
1515
======================
1616

1717
It is an essential pytest_ plugin designed for Celery application developers.
@@ -33,7 +33,7 @@ What do I need?
3333
===============
3434

3535
.. sidebar:: Version Requirements
36-
:subtitle: Pytest Celery version 1.0 runs on
36+
:subtitle: pytest-celery version 1.0 runs on
3737

3838
- Python ❨3.8, 3.9, 3.10, 3.11, 3.12❩
3939

@@ -86,7 +86,7 @@ into a simple interface. It is highly recommended to familiarize yourself with t
8686

8787
Additional resources can be found in the :ref:`resources` section.
8888

89-
Pytest Celery is…
89+
pytest-celery is…
9090
=================
9191

9292
.. topic:: \

docs/index.rst

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
1-
===================================================
2-
Pytest Celery - Official pytest plugin for Celery
3-
===================================================
1+
===================================
2+
Official pytest plugin for Celery
3+
===================================
44

5-
.. warning::
5+
Welcome to :pypi:`pytest-celery <pytest-celery>`, the official pytest plugin for Celery.
66

7-
Documentation under construction!
7+
The pytest-celery plugin introduces significant enhancements with the introduction of
8+
version >= 1.0.0, shifting towards a Docker-based approach for smoke and production-like testing.
9+
While the `celery.contrib.pytest` API continues to support detailed integration
10+
and unit testing, the new Docker-based methodology is tailored for testing in
11+
environments that closely mirror production settings.
812

9-
Welcome to pytest-celery, the official pytest plugin for Celery.
13+
Adopting version >= 1.0.0 enriches your testing suite with these new capabilities
14+
without affecting your existing tests, allowing for a smooth upgrade path.
15+
The documentation here will navigate you through utilizing the Docker-based approach.
16+
For information on the `celery.contrib.pytest` API for integration and unit testing,
17+
please refer to the `official documentation`_.
1018

11-
Pytest Celery is Open Source and licensed under the `BSD License`_.
19+
.. _`official documentation`: https://docs.celeryproject.org/en/latest/userguide/testing.html
20+
21+
The pytest-celery plugin is Open Source and licensed under the `BSD License`_.
1222

1323
.. _`BSD License`: http://www.opensource.org/licenses/BSD-3-Clause
1424

@@ -17,8 +27,8 @@ Donations
1727

1828
This project relies on your generous donations.
1929

20-
If you are using Pytest Celery to test a commercial product, please consider becoming
21-
our `backer`_ or our `sponsor`_ to ensure Pytest Celery's future.
30+
If you are using pytest-celery to test a commercial product, please consider becoming
31+
our `backer`_ or our `sponsor`_ to ensure pytest-celery's future.
2232

2333
.. _`backer`: https://opencollective.com/celery
2434
.. _`sponsor`: https://opencollective.com/celery

0 commit comments

Comments
 (0)