Skip to content
New issue

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

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

Already on GitHub? # to your account

Add sphinx extension #1152

Merged
merged 10 commits into from
Aug 11, 2024
Merged

Add sphinx extension #1152

merged 10 commits into from
Aug 11, 2024

Conversation

ewjoachim
Copy link
Member

Closes #865

Procrastinate Tasks don't get documented by Sphinx Autodoc. It's a bit sad, but with a very short sphinx extension, we can solve it. So... I guess we have a new contrib.

Successful PR Checklist:

  • Tests
    • (not applicable?)
  • Documentation
    • (not applicable?)

PR label(s):

@ewjoachim ewjoachim requested a review from a team as a code owner August 10, 2024 22:14
@github-actions github-actions bot added the PR type: bugfix 🕵️ Contains bug fix label Aug 10, 2024
Copy link

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  procrastinate/contrib/sphinx
  __init__.py
Project Total  

This report was generated by python-coverage-comment-action

tests/conftest.py Outdated Show resolved Hide resolved
@medihack
Copy link
Member

Nice. Procrastinate is full of little details. Let's get it in there :-)

@ewjoachim ewjoachim merged commit e28d38c into main Aug 11, 2024
11 checks passed
@ewjoachim ewjoachim deleted the sphinx-autodoc branch August 11, 2024 20:36
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
PR type: bugfix 🕵️ Contains bug fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug(Sphinx): Autodoc fails to document wrapped functions
2 participants