Skip to content

fix: added graphviz to build packages#209

Open
peterkomar-aws wants to merge 3 commits intomainfrom
documentation/add-graphviz
Open

fix: added graphviz to build packages#209
peterkomar-aws wants to merge 3 commits intomainfrom
documentation/add-graphviz

Conversation

@peterkomar-aws
Copy link

Issue #, if available:
Documentation (https://amazon-braket-pennylane-plugin-python.readthedocs.io/en/latest/code.html#class-inheritance-diagram) does not display the graph.

Description of changes:
Based on this successful PR on the Pennylan repo (PennyLaneAI/pennylane#4284), I am adding graphviz package to build environment to create.

Testing done:

I was not able to test it, because I don't have dot installed on my machine. Please help.

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@peterkomar-aws peterkomar-aws requested a review from a team as a code owner October 2, 2023 16:45
@peterkomar-aws
Copy link
Author

I run tox -e docs to build the documentation locally, but I received this warning that seemed relevant:

WARNING: dot command 'dot' cannot be run (needed for graphviz output), check the graphviz_dot setting

And the page at amazon-braket-pennylane-plugin-python/build/documentation/html/code.html still does not show the graph.

@codecov
Copy link

codecov bot commented Oct 2, 2023

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (21e21c6) to head (e7ba647).
⚠️ Report is 16 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #209   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            7         7           
  Lines         1256      1256           
  Branches       179       179           
=========================================
  Hits          1256      1256           

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

tools:
python: "3.8"
apt_packages:
- graphviz
Copy link
Contributor

Choose a reason for hiding this comment

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

Would using the graphviz plugin work for this?

@AbeCoull AbeCoull changed the title added graphviz to build packages fix: added graphviz to build packages Oct 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants