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

replace blockdiag with graphviz in docs #9359

Merged
merged 7 commits into from
Oct 1, 2024

Conversation

Cycloctane
Copy link
Contributor

@Cycloctane Cycloctane commented Sep 30, 2024

What do these changes do?

  • replace blockdiag with graphviz in docs/tracing_reference.rst
  • remove sphinxcontrib-blockdiag dependency in requirements

Are there changes in behavior for the user?

Is it a substantial burden for the maintainers to support this?

Related issue number

Fixes #9134

Checklist

  • I think the code is well written
  • Unit tests for the changes exist
  • Documentation reflects the changes
  • If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • Add a new news fragment into the CHANGES/ folder
    • name 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 an
        improper 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 breaking
        changes 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 build
        process.
      • .packaging: Notes for downstreams about unobvious side effects
        and 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 above
        categories.
    • Make sure to use full sentences with correct case and punctuation,
      for example:

      Fixed issue with non-ascii contents in doctest text files
      -- by :user:`contributor-gh-handle`.

      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.

@Cycloctane Cycloctane added the documentation Improvements or additions to documentation label Sep 30, 2024
Copy link

codecov bot commented Sep 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.56%. Comparing base (2628256) to head (7615b50).
Report is 7 commits behind head on master.

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           
Flag Coverage Δ
CI-GHA 98.44% <ø> (+<0.01%) ⬆️
OS-Linux 98.10% <ø> (+<0.01%) ⬆️
OS-Windows 96.51% <ø> (+<0.01%) ⬆️
OS-macOS 97.79% <ø> (-0.01%) ⬇️
Py-3.10.11 97.66% <ø> (-0.01%) ⬇️
Py-3.10.15 97.60% <ø> (-0.01%) ⬇️
Py-3.11.10 97.66% <ø> (+<0.01%) ⬆️
Py-3.11.9 97.74% <ø> (+<0.01%) ⬆️
Py-3.12.6 98.15% <ø> (+<0.01%) ⬆️
Py-3.13.0-rc.2 98.14% <ø> (+<0.01%) ⬆️
Py-3.9.13 97.56% <ø> (-0.01%) ⬇️
Py-3.9.20 97.50% <ø> (-0.01%) ⬇️
Py-pypy7.3.16 97.12% <ø> (-0.01%) ⬇️
VM-macos 97.79% <ø> (-0.01%) ⬇️
VM-ubuntu 98.10% <ø> (+<0.01%) ⬆️
VM-windows 96.51% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@Cycloctane
Copy link
Contributor Author

Note that GraphViz requires additonal packages to be installed to render diagrams when building documentation. This change haven't been presented yet.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Sep 30, 2024
docs/conf.py Outdated Show resolved Hide resolved
Copy link
Member

@Dreamsorcerer Dreamsorcerer left a 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.

@Dreamsorcerer
Copy link
Member

Dreamsorcerer commented Sep 30, 2024

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...

@Cycloctane
Copy link
Contributor Author

Cycloctane commented Oct 1, 2024

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.

@Dreamsorcerer Dreamsorcerer added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Oct 1, 2024
@Dreamsorcerer
Copy link
Member

I think that works well enough. Thanks for that.

@Dreamsorcerer Dreamsorcerer merged commit a9ac5e2 into aio-libs:master Oct 1, 2024
38 of 40 checks passed
Copy link
Contributor

patchback bot commented Oct 1, 2024

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

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/aio-libs/aiohttp.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/3.11/a9ac5e218869ae58e72867ec493ad1af6a9f31e8/pr-9359 upstream/3.11
  4. Now, cherry-pick PR replace blockdiag with graphviz in docs #9359 contents into that branch:
    $ git cherry-pick -x a9ac5e218869ae58e72867ec493ad1af6a9f31e8
    If it'll yell at you with something like fatal: Commit a9ac5e218869ae58e72867ec493ad1af6a9f31e8 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x a9ac5e218869ae58e72867ec493ad1af6a9f31e8
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR replace blockdiag with graphviz in docs #9359 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/a9ac5e218869ae58e72867ec493ad1af6a9f31e8/pr-9359
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@Dreamsorcerer
Copy link
Member

Could you handle the backport as well?

Cycloctane added a commit to Cycloctane/aiohttp that referenced this pull request Oct 1, 2024
(replace blockdiag with graphviz in docs)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace blockdiag
2 participants