readme: on how to run the docs locally #7
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Huong Nguyen <huongg1409@gmail>
astrojuanlu
reviewed
Jun 26, 2024
There was a problem hiding this comment.
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 😄 |
|
Closing this PR as this has now moved to wiki page here |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 😄