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

Documentation for matplotlib artifacts is in page called visualise_charts_with_plotly.html #2527

Closed
astrojuanlu opened this issue Apr 18, 2023 · 7 comments
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@astrojuanlu
Copy link
Member

Description

I was searching for a way to add matplotlib plots to a Kedro Viz node (thanks @rashidakanchwala!) and landed in
https://docs.kedro.org/en/stable/visualisation/visualise_charts_with_plotly.html?highlight=matplotlib#visualisation-with-matplotlib. I think we should rename that page to visualise_charts_with_kedro_viz, custom_plots or something like that.

Alternatively, we could split it in two: one for Plotly and one for matplotlib.

@Gundalai-Batkhuu
Copy link

Can I take this one?

@astrojuanlu
Copy link
Member Author

Hello @Gundalai-Batkhuu , sure thing! My original message was a bit open ended - can you tell us what do you intend to do?

@Gundalai-Batkhuu
Copy link

Hello @astrojuanlu. I have noticed that the docs are generated using Sphinx. I'm thinking to separate the markdown file 'visualise_charts_with_plotly' into two: one for Plotly and one for matplotlib as you have suggested. Then I will update the toctree of the parent index.md file.
Please let me know if my approach is correct. I'm a CS student :)

@astrojuanlu
Copy link
Member Author

Sounds good! An alternative would be to have 1 page for both, but change the URL. @stichbury what do you think would be best?

@stichbury
Copy link
Contributor

This is so weird as I'm literally doing this right now as part of changes I'm making for kedro-org/kedro-viz#1524 where i've created a new docs project just for Kedro-Viz.

I'm sorry @Gundalai-Batkhuu that I've been (possibly) duplicating your work. You are welcome to submit anyway if you've made changes but if you haven't, then please leave this one for now as it'll be resolved by my broader work.

@Gundalai-Batkhuu
Copy link

@stichbury Sorry I had already made the changes. I have just submitted a pull request. Please let me know if I did anything incorrectly. This is my first ever open source contribution. I'm happy to work on other issues.

@astrojuanlu
Copy link
Member Author

This is not yet reflected on the project documentation but it was addressed by @stichbury in kedro-org/kedro-viz#1586

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants