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

[fix] Added graphviz dependency (Resolves #637) #660

Merged
merged 4 commits into from
Sep 5, 2024

Conversation

SaxenaAnushka102
Copy link
Contributor

Added graphviz to requirements.txt

Resolves #637

BEGINRELEASENOTES

  • Added missing dependency graphviz for podio-vis functionality in the documentation build process.

ENDRELEASENOTES

Added graphviz to requirements.txt
Copy link
Collaborator

@tmadlener tmadlener left a comment

Choose a reason for hiding this comment

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

Thanks. A few minor comments.

requirements.txt Outdated Show resolved Hide resolved
@@ -20,6 +20,7 @@ docutils==0.20.1
# myst-parser
# sphinx
# sphinx-rtd-theme
graphviz
Copy link
Collaborator

Choose a reason for hiding this comment

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

This actually needs to go here and then we use pip-compile to generate the actual requirements.txt from there.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tmadlener Thanks for explaining, I've updated requirements.in . I'm sorry for adding the dependency to an auto-generated file 😅

@tmadlener
Copy link
Collaborator

Sorry, this might have been a bit confusing if you are not completely familiar with podios structure. There are actually two requirements.txt files:

  • We have this requirements.txt at the top level. This is what is necessary to use podio and it's python bindings.
  • We have another one in doc/requirements.txt. This is the one that is generated from the requirements.in in the same folder. These are the dependencies to generate and build the documentation of podio.

Hence, what you want to change for fixing the issue is the first one and not the requirements.in.

@@ -2,4 +2,4 @@ breathe
myst-parser
sphinx
sphinx_rtd_theme
sphinx_copybutton
sphinx_copybutton
Copy link
Collaborator

@tmadlener tmadlener Sep 4, 2024

Choose a reason for hiding this comment

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

Suggested change
sphinx_copybutton
sphinx_copybutton

Simply to not touch this file in this PR.

edit: github doesn't really deal with this properly. the fix is to add a newline after sphinx_copybutton (same for the suggestion below).

requirements.txt Outdated
@@ -2,3 +2,4 @@
pyyaml
jinja2
tabulate
graphviz
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
graphviz
graphviz

Something in your editor settings seems to strip off the last newline in each file.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, you're right. I'll check for the new lines from next time. Thanks!

requirements.txt Outdated Show resolved Hide resolved
Copy link
Collaborator

@tmadlener tmadlener left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your work (and patience). Waiting for the CI to run to completion before merging.

@tmadlener tmadlener merged commit 6d8e02c into AIDASoft:master Sep 5, 2024
18 checks passed
@m-fila m-fila mentioned this pull request Sep 6, 2024
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.

graphviz needs to be in requirements.txt
2 participants