Skip to content

Add plugincodes sphinx directive#3484

Merged
sobolevn merged 14 commits intowemake-services:masterfrom
skv0zsneg:add-plugincodes-sphinx-directive
Jul 14, 2025
Merged

Add plugincodes sphinx directive#3484
sobolevn merged 14 commits intowemake-services:masterfrom
skv0zsneg:add-plugincodes-sphinx-directive

Conversation

@skv0zsneg
Copy link
Copy Markdown
Contributor

@skv0zsneg skv0zsneg commented Jul 8, 2025

I have made things!

Checklist

  • I have double checked that there are no unrelated changes in this pull request (old patches, accidental config files, etc)
  • I have created at least one test case for the changes I have made (Do we need tests for this custom local feature?)
  • I have updated the documentation for the changes I have made (Do we need write about this changes in docs?)
  • I have added my changes to the CHANGELOG.md

Related issues

Description

Hi!

I've add custom Sphinx directive .. plugincodes so it now can render violation page just by line:

.. plugincodes:: wemake_python_styleguide.violations.best_practices

For using new directive I've changed only best practices .rst page and docstring module for checking the work.

sobolevn
sobolevn reviewed Jul 12, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Don't forget to fix tests please :)

Comment thread CHANGELOG.md Outdated
Comment thread CHANGELOG.md Outdated
Comment thread docs/ext/plugincodes.py Outdated
Comment thread docs/ext/plugincodes.py
Comment thread docs/pages/usage/violations/best_practices.rst
@codecov
Copy link
Copy Markdown

codecov Bot commented Jul 14, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (326b8cf) to head (be21b51).
⚠️ Report is 40 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff            @@
##            master     #3484   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          363       363           
  Lines        12032     12020   -12     
  Branches       822       819    -3     
=========================================
- Hits         12032     12020   -12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

sobolevn
sobolevn approved these changes Jul 14, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

Great stuff!
As the next step we can change how classes are rendered if you are interested :)

@sobolevn sobolevn merged commit f893f91 into wemake-services:master Jul 14, 2025
9 checks passed
@skv0zsneg
Copy link
Copy Markdown
Contributor Author

skv0zsneg commented Jul 15, 2025

Thank you!

Great stuff!
As the next step we can change how classes are rendered if you are interested :)

Thanks, I liked working on it)
Yeah, I can take a look to the next step, that the number of issue about class rendering?

@sobolevn
Copy link
Copy Markdown
Member

sobolevn commented Jul 15, 2025

We need to create one :)
There's a lot of stuff we don't need
Снимок экрана 2025-07-15 в 16 56 03

@skv0zsneg skv0zsneg mentioned this pull request Jul 16, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sobolevn sobolevn sobolevn approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Create .. plugincodes sphinx directive

2 participants

@skv0zsneg @sobolevn