fix: failing docs #728
Merged
fix: failing docs #728
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
MAfarrag
commented
Jan 20, 2025
| markdown_extensions: | ||
| - pymdownx.highlight | ||
| - pymdownx.superfences | ||
| - admonition | ||
| - toc: | ||
| permalink: true | ||
| - pymdownx.emoji: | ||
| emoji_index: !!python/name:materialx.emoji.twemoji | ||
| emoji_generator: !!python/name:materialx.emoji.to_svg | ||
| emoji_index: !!python/name:material.extensions.emoji.twemoji |
There was a problem hiding this comment.
because of a deprication warning
MAfarrag
commented
Jan 20, 2025
| @@ -41,18 +41,15 @@ plugins: | |||
| selection: | |||
| inherited_members: false | |||
|
|
|||
| custom_templates: templates | |||
There was a problem hiding this comment.
template directory does not exist
MAfarrag
commented
Jan 20, 2025
| - autorefs | ||
| - table-reader | ||
|
|
There was a problem hiding this comment.
table-reader gives error when it comes before the macros plugins
MAfarrag
commented
Jan 20, 2025
| @@ -22,11 +22,11 @@ theme: | |||
| - navigation.top | |||
| plugins: | |||
| - search | |||
| - mkdocs-jupyter | |||
There was a problem hiding this comment.
mkdocs-jupyter gives an error of
[ModuleNotFoundError: No module named 'notebook.services' error](https://github.com/Deltares/HYDROLIB-core/pull/728/commits/04c398b3a121d5f7fec2e2fb1854e6763e625be5)
|
Hey @priscavdsluis @veenstrajelmer can you check this merge? Thanks |
tim-vd-aardweg
approved these changes
Jan 21, 2025
|
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.
Fix Documentation build (fix #727 )
docs, anddocs_releaseworkflows are failing since version 0.5.2.mkdocs-jupyterdependency as it was the reason of the workflow failure.templatedirectory that was specified in themkdocs.ymland does not exist in thedocsdirectory which was also a reason why the docs build was not passing.I added comments on the places where the changes are made.failing tests locally in
WinodwsExceptionon all theshutil.rmtreethat tries to delete previuos test files as sometimes it fails because ofPermissionError, the deletion does not affect tests themselves.Dev
mkdocsto a separate dependency groupdocsso that in thedocsand thedocs_releaseCI workflows we install this group of dependencies only and not everything.