diff --git a/Changelog.rst b/Changelog.rst index 6d71d541..54c17a41 100644 --- a/Changelog.rst +++ b/Changelog.rst @@ -4,4 +4,4 @@ Change history ================ -TBD +No changes yet. diff --git a/docs/_templates/sidebardonations.html b/docs/_templates/sidebardonations.html new file mode 100644 index 00000000..6e50b444 --- /dev/null +++ b/docs/_templates/sidebardonations.html @@ -0,0 +1,9 @@ + + diff --git a/docs/conf.py b/docs/conf.py index 705eee0c..bd18ae92 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -5,28 +5,25 @@ "pytest_celery", __file__, project="Pytest Celery", - version_dev="2.0", + version_dev="1.1", version_stable="1.0", - canonical_url="https://docs.pytest-celery.dev", # Update with your documentation URL - webdomain="pytest-celery.dev", # Update with your domain + canonical_url="https://pytest-celery.readthedocs.io/", + webdomain="pytest-celery.readthedocs.io", github_project="celery/pytest-celery", author="Tomer Nosrati", author_name="Tomer Nosrati", - copyright="2023", + copyright="2024", publisher="Celery Project", - # html_logo='images/logo.png', - # html_favicon='images/favicon.ico', + html_logo="images/celery_512.png", + html_favicon="images/favicon.ico", + html_prepend_sidebars=["sidebardonations.html"], extra_extensions=[ "sphinx_click", "sphinx.ext.napoleon", - # ... other extensions ... + "celery.contrib.sphinx", + ], + apicheck_ignore_modules=[ + "celery.contrib", ], - extra_intersphinx_mapping={ - # ... other intersphinx mappings ... - }, - apicheck_ignore_modules=[], - linkcheck_ignore=[r"^http://localhost"], ) ) - -settings = {} diff --git a/docs/images/celery_512.png b/docs/images/celery_512.png new file mode 100644 index 00000000..25163151 Binary files /dev/null and b/docs/images/celery_512.png differ diff --git a/docs/images/favicon.ico b/docs/images/favicon.ico new file mode 100644 index 00000000..163234f2 Binary files /dev/null and b/docs/images/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst index 0bac436e..55bd179b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,27 +1,30 @@ =================================================== - pytest-celery - Testing Infrastructure for Celery + pytest-celery - Official pytest plugin for Celery =================================================== -TBD +Welcome to pytest-celery, the official pytest plugin for Celery. -pytest-celery has a growing community of users and contributors. Join us -in making pytest-celery even better! +Pytest Celery is Open Source and licensed under the `BSD License`_. -pytest-celery is Open Source and licensed under the BSD License. +.. _`BSD License`: http://www.opensource.org/licenses/BSD-3-Clause -Supporting pytest-celery -======================== +Donations +========= -Your contributions support the continued development of pytest-celery. +This project relies on your generous donations. -If you find pytest-celery valuable, please consider supporting us to ensure its -future growth and maintenance. +If you are using Pytest Celery to test a commercial product, please consider becoming our `backer`_ or our `sponsor`_ to ensure Pytest Celery's future. + +.. _`backer`: https://opencollective.com/celery#backer +.. _`sponsor`: https://opencollective.com/celery#sponsor Getting Started =============== -- Begin your journey with pytest-celery by following the :ref:`getting-started`. -- For common questions, you might want to check out the :ref:`faq`. +- If you're new to Celery you can get started by following + the :ref:`first-steps` tutorial. + +- You can also check out the :ref:`FAQ `. Contents ======== @@ -34,7 +37,6 @@ Contents .. toctree:: :maxdepth: 1 - introduction getting-started/index .. toctree:: @@ -48,3 +50,9 @@ Contents faq changelog contributing + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` diff --git a/poetry.lock b/poetry.lock index 1832a39b..dca43e7e 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1126,13 +1126,13 @@ trio = ["async_generator", "trio"] [[package]] name = "jinja2" -version = "3.1.2" +version = "3.1.3" description = "A very fast and expressive template engine." optional = false python-versions = ">=3.7" files = [ - {file = "Jinja2-3.1.2-py3-none-any.whl", hash = "sha256:6088930bfe239f0e6710546ab9c19c9ef35e29792895fed6e6e31a023a182a61"}, - {file = "Jinja2-3.1.2.tar.gz", hash = "sha256:31351a702a408a9e7595a8fc6150fc3f43bb6bf7e319770cbc0db9df9437e852"}, + {file = "Jinja2-3.1.3-py3-none-any.whl", hash = "sha256:7d6d50dd97d52cbc355597bd845fabfbac3f551e1f99619e39a35ce8c370b5fa"}, + {file = "Jinja2-3.1.3.tar.gz", hash = "sha256:ac8bd6544d4bb2c9792bf3a159e80bba8fda7f07e81bc3aed565432d5925ba90"}, ] [package.dependencies] @@ -2517,13 +2517,13 @@ test = ["pytest", "pytest-cov"] [[package]] name = "sphinx-celery" -version = "2.0.0" +version = "2.1.1" description = "Sphinx Celery Theme." optional = false python-versions = "*" files = [ - {file = "sphinx_celery-2.0.0-py2.py3-none-any.whl", hash = "sha256:9326c150600e2c8299f356283e6397f15493370368c4b68697edd98beac9f868"}, - {file = "sphinx_celery-2.0.0.tar.gz", hash = "sha256:d8e440b5b0c3bb015a3404586bcec4f1a3e9aaee9fa0073511c32c8d4cd3d3dd"}, + {file = "sphinx_celery-2.1.1-py2.py3-none-any.whl", hash = "sha256:4cde4799d1315514528cd6fd49c528b8039f00ba3cece887fdcbfa927e1105ce"}, + {file = "sphinx_celery-2.1.1.tar.gz", hash = "sha256:5d22a1331f36a3975e58d98be2b69479cec975dd3e02f579b7435e4c25a9800c"}, ] [package.dependencies]