Open boegel opened 1 year ago
I'm happy to make the extra effort in this PR to update the README
file with a new section that documents this feature, and to implement a test to verify that the feature works as expected, but I would like to get some feedback first on whether this feature would be accepted for inclusing in mkdocs-redirects
before doing so.
Just a few days ago I was thinking that something like this would be good, because indeed, the current setup assumes you're migrating from an exact same MkDocs setup (even down to use_directory_urls
). And I actually think this shouldn't even be behind a config. But I'll need to carefully look at the code myself first. It would be good to have this as an issue instead, to clearly define what use case we're solving. Though I see that in the description of your pull request you do define the use case very well, definitely thanks for that!
@oprypin Thanks for the feedback, I've opened an issue for this at #51
@oprypin what's the current status here?
I'm porting documentation that currently uses Sphinx +
.rst
to 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-redirects
is logging warnings when.html
URLs are redirected:That's annoying, since I would like to use
mkdocs build --strict
in 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-redirects
withallow_html_redirects
to silence the warning: