chore: Fix infinite live reloading of the docs #36
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
Codecov Report
@@ Coverage Diff @@
## master #36 +/- ##
=======================================
Coverage 52.18% 52.18%
=======================================
Files 43 43
Lines 6241 6241
=======================================
Hits 3257 3257
Misses 2984 2984 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
Higgcz
force-pushed
the
fix/docs-live-reload-loop
branch
from
adce770
to
8077bc2
Compare
Higgcz
added
documentation
Higgcz
force-pushed
the
fix/docs-live-reload-loop
branch
from
8077bc2
to
0cb620f
Compare
|
This is ready for merging, but it needs to be merged after #39 |
Previously, the docs would reload infinitely because there was a hook that automatically generated markdown files out of jupyter notebooks. The problem was that the generated markdown files were stored directly into docs folder, which triggered mkdocs to rebuild again. This patch changes the target directory of the generated files and adds a new mkdocs hook (`on_files`) that adds all the files during the build process. This way the autogenerated files are not triggering the reload.
Higgcz
force-pushed
the
fix/docs-live-reload-loop
branch
from
e5a0892
to
a33174b
Compare
Higgcz
force-pushed
the
fix/docs-live-reload-loop
branch
from
a33174b
to
4c086a1
Compare
engintoklu
approved these changes
Nov 21, 2022
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.
Previously, the docs would reload infinitely because there was a hook that automatically generated markdown files out of Jupyter notebooks.
The problem was that the generated markdown files were stored directly in the docs folder, which triggered mkdocs to rebuild again.
This PR changes the target directory of the generated files and adds a new mkdocs hook (
on_files) that adds all the files during the build process. This way the autogenerated files are not triggering the reload.Waiting for #39