amazon-braket-pennylane-plugin-python icon indicating copy to clipboard operation
amazon-braket-pennylane-plugin-python copied to clipboard

added graphviz to build packages

Open peterkomar-aws opened this issue 1 year ago • 2 comments

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 (https://github.com/PennyLaneAI/pennylane/pull/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

  • [x] I have read the CONTRIBUTING doc
  • [x] I used the commit message format described in CONTRIBUTING
  • [x] I have updated any necessary documentation, including READMEs and API docs (if appropriate)

Tests

  • [ ] I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • [x] 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 avatar Oct 02 '23 16:10 peterkomar-aws

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.

peterkomar-aws avatar Oct 02 '23 16:10 peterkomar-aws

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (abe0dfe) 100.00% compared to head (a6ec788) 100.00%.

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Oct 02 '23 16:10 codecov[bot]