search

kedro-org / kedro-sphinx-theme

Apache License 2.0
2 stars 0 forks source link

readme: on how to run the docs locally #7

Closed Huongg closed 2 weeks ago

Huongg commented 3 weeks ago

Description:

I've added a few steps on how to run the doc locally with kedro-sphinx-theme, so that you can see your changes locally

Thank you @astrojuanlu for showing all the steps and tips on how to run them quickly. So far I only run this with kedro-viz locally, and I hope all the steps are applied even for kedro or kedro-dataset. Let me know whether this is the case or not 😄

Huongg commented 3 weeks ago

Thanks a lot for documenting this @Huongg !! 🙌🏼

Since we started moving developer documentation to the wiki (see for instance https://github.com/kedro-org/kedro/wiki), do you want to document this there instead? (Since it applies to all the projects, not only kedro-viz)

agree @astrojuanlu , let me move this to the wiki page 😄

Huongg commented 2 weeks ago

Closing this PR as this has now moved to wiki page here