Closed AgnesBelt closed 3 months ago
Thanks for the PR, @AgnesBelt! We do mention how to install graphviz
in the examples section -- however, neglect to show how to install it with conda
, which is useful!. Do you think it would be useful to change the location of this warning to the core functionality, or leave in the examples? In any case, adding in the conda option is good!
https://otoole.readthedocs.io/en/latest/examples.html#otoole-visualise
Oh, now I see it! I have totally missed the warning in the exercise section, sorry.
I would suggest to add the same warning to the core functionality section as well, as I believe it useful as a reminder in any case - as my experience shows, some people might only check in the core functionalities as they maybe are familiar with otoole already but they forgot how to use different commands/fucntionalities.
Also the brew install graphviz
did not work for me on my Mac, so it would be definitely important to add in both places also the option with conda install graphviz
as suggested earlier.
Apologies for just getting back to this now, @AgnesBelt! Following your suggestions, I have:
Additionally, just minor liniting is done to make this PR pass checks. Thanks again for your contribution! :)
Added instructions to install graphviz under
docs/functionality.rst
.Description
I have just added few sentences in the documentation to flag the need for gaphviz to be installed, if the user wants to use the
otoole viz
functionality.Issue Ticket Number
No issue raised.
Documentation
docs/functionality.rst