Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx Hotfix #162

Merged
merged 5 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
Change history
================

TBD
No changes yet.
9 changes: 9 additions & 0 deletions docs/_templates/sidebardonations.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<iframe src="https://ghbtns.com/github-btn.html?user=celery&repo=pytest-celery&type=watch&count=true&size=large"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
<div id="donate">
<h3>Donations</h3>
<p>Please help support this community project with a donation.</p>
<a href="https://opencollective.com/celery/donate" target="_blank">
<img src="https://opencollective.com/celery/donate/button@2x.png?color=blue" />
</a>
</div>
25 changes: 11 additions & 14 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {}
Binary file added docs/images/celery_512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/favicon.ico
Binary file not shown.
34 changes: 21 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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 <faq>`.

Contents
========
Expand All @@ -34,7 +37,6 @@ Contents
.. toctree::
:maxdepth: 1

introduction
getting-started/index

.. toctree::
Expand All @@ -48,3 +50,9 @@ Contents
faq
changelog
contributing

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
12 changes: 6 additions & 6 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.