add 'allow_html_redirect' configuration option to avoid printing warning when redirecting .html URLs#50
Open
boegel wants to merge 1 commit intomkdocs:masterfrom
Open
add 'allow_html_redirect' configuration option to avoid printing warning when redirecting .html URLs#50boegel wants to merge 1 commit intomkdocs:masterfrom
boegel wants to merge 1 commit intomkdocs:masterfrom
Conversation
…ing when redirecting .html URLs
Author
|
I'm happy to make the extra effort in this PR to update the |
This comment was marked as abuse.
This comment was marked as abuse.
Author
|
@oprypin what's the current status here? |
jrappen
reviewed
Jan 26, 2023
| if not utils.is_markdown_file(page_old): | ||
| log.warning("redirects plugin: '%s' is not a valid markdown file!", page_old) | ||
| if not (allow_html and page_old.lower().endswith(('html', 'htm'))): | ||
| log.warning("redirects plugin: '%s' is not a valid markdown file!", page_old) |
There was a problem hiding this comment.
should be ... not a valid md or html ..., yes?
This file contains hidden or 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
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.
I'm porting documentation that currently uses Sphinx +
.rstto MkDocs +md, and I would like to ensure that redirects are in place for old URLs likehttps://docs.easybuild.io/en/latest/Configuration.html.To achieve this, I'm using
mkdocs-redirects, as follows inmkdocs.yml:That's working fine (see https://easybuilders.github.io/easybuild-docs/en/latest/Configuration.html which correctly redirects), but
mkdocs-redirectsis logging warnings when.htmlURLs are redirected:That's annoying, since I would like to use
mkdocs build --strictin CI to test changes to our documentation, and that exits with a non-zero exit code as soon there as any warnings.The changes being proposed here allow configuring
mkdocs-redirectswithallow_html_redirectsto silence the warning: