mckinsey / vizro

Vizro is a toolkit for creating modular data visualization applications.
https://vizro.readthedocs.io/en/stable/
Apache License 2.0
2.46k stars 109 forks source link

[Docs] Add documentation and examples for `Figure` #524

Closed huong-li-nguyen closed 1 week ago

huong-li-nguyen commented 2 weeks ago

Description

https://vizro--524.org.readthedocs.build/en/524/pages/user-guides/figure/ https://vizro--524.org.readthedocs.build/en/524/pages/user-guides/custom-figures/

More cross-links to the KPI card functions can be found in this PR: https://github.com/mckinsey/vizro/pull/529

Screenshot

Notice

antonymilne commented 1 week ago

FYI @stichbury @huong-li-nguyen I pushed ea5cf95 so that the linkchecker ignores links to our built RTD - otherwise it's impossible to add new pages to our docs since it will always fail on CI like you found here.

I've also pushed https://github.com/mckinsey/vizro/pull/535 which will make our checks stricter so that it's not possible to link to a page that doesn't exist in our docs. This means that there's no need to check the built RTD docs any more.

huong-li-nguyen commented 1 week ago

@antonymilne @stichbury - could the two of you take a final look? Thank you! 🙏