-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
replace blockdiag with graphviz in docs #9359
replace blockdiag with graphviz in docs #9359
Conversation
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #9359 +/- ##
=======================================
Coverage 98.56% 98.56%
=======================================
Files 107 107
Lines 34949 34981 +32
Branches 4139 4149 +10
=======================================
+ Hits 34446 34478 +32
Misses 335 335
Partials 168 168
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Note that GraphViz requires additonal packages to be installed to render diagrams when building documentation. This change haven't been presented yet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you follow the link from the RTD job in the PR (https://aiohttp--9359.org.readthedocs.build/en/9359/tracing_reference.html) you can preview the docs. Currently, there are no diagrams rendered.
I'm guessing that might be because of your comment about needing another package, though I'm a little surprised the build doesn't fail if a dependency is missing... |
I've added the dependency package to .readthedocs.yml. Now it seems to be working. |
I think that works well enough. Thanks for that. |
Backport to 3.11: 💔 cherry-picking failed — conflicts found❌ Failed to cleanly apply a9ac5e2 on top of patchback/backports/3.11/a9ac5e218869ae58e72867ec493ad1af6a9f31e8/pr-9359 Backporting merged PR #9359 into master
🤖 @patchback |
Could you handle the backport as well? |
(replace blockdiag with graphviz in docs)
What do these changes do?
sphinxcontrib-blockdiag
dependency in requirementsAre there changes in behavior for the user?
Is it a substantial burden for the maintainers to support this?
Related issue number
Fixes #9134
Checklist
CONTRIBUTORS.txt
CHANGES/
foldername it
<issue_or_pr_num>.<type>.rst
(e.g.588.bugfix.rst
)if you don't have an issue number, change it to the pull request
number after creating the PR
.bugfix
: A bug fix for something the maintainers deemed animproper undesired behavior that got corrected to match
pre-agreed expectations.
.feature
: A new behavior, public APIs. That sort of stuff..deprecation
: A declaration of future API removals and breakingchanges in behavior.
.breaking
: When something public is removed in a breaking way.Could be deprecated in an earlier release.
.doc
: Notable updates to the documentation structure or buildprocess.
.packaging
: Notes for downstreams about unobvious side effectsand tooling. Changes in the test invocation considerations and
runtime assumptions.
.contrib
: Stuff that affects the contributor experience. e.g.Running tests, building the docs, setting up the development
environment.
.misc
: Changes that are hard to assign to any of the abovecategories.
Make sure to use full sentences with correct case and punctuation,
for example:
Use the past tense or the present tense a non-imperative mood,
referring to what's changed compared to the last released version
of this project.