Sphinx Extension to redirect files
This sphinx extension redirects non-existent pages to working pages. Rediraffe can also check that deleted/renamed files in your git repo are redirected.
Rediraffe creates a graph of all specified redirects and traverses it to point all internal urls to leaf urls. This means that chained redirects will be resolved. For example, if a config has 6 chained redirects, all 6 links will redirect directly to the final link. The end user will never experience more than 1 redirection.
Note: Rediraffe supports the html and dirhtml builders.
python -m pip install sphinxext-rediraffe
Add sphinxext.rediraffe to your extensions list in your conf.py
extensions = [
"sphinxext.rediraffe",
]
Set rediraffe_redirects to a dict or file of redirects in your conf.py
The diff checker ensures that deleted/renamed files in your git repo are in your redirects.
To run the diff checker,
rediraffe_branch and rediraffe_redirects in conf.py.rediraffecheckdiff builder.The auto redirect builder can be used to automatically add renamed files to your redirects file. Simply run the rediraffewritediff builder.
To run the auto redirecter:
rediraffe_branch and rediraffe_redirects in conf.py.rediraffewritediff builder.Note: The auto redirect builder only works with a configuration file. Note: Deleted files cannot be added to your redirects file automatically.
These values are placed in the conf.py of your sphinx project.
rediraffe_branch
rediraffecheckdiff and rediraffewritediff builders. The branch or commit to diff against.rediraffe_redirects
rediraffe_template
from_file - the file being redirected as written in rediraffe_redirects.to_file - the destination file that from_file is redirected to as written in rediraffe_redirects.from_url - the path to from_url's html file (built by rediraffe) relative to the outdir.to_url - the path to to_url's built html file relative to the outdir.rel_url - the relative path from from_url to to_url.rediraffe_auto_redirect_perc
rediraffewritediff builder. The percentage as an integer representing the accuracy required before auto redirecting with the rediraffewritediff builder. The default is 100.conf.py:
rediraffe_redirects = "redirects.txt"
redirects.txt:
# comments start with "#"
"another file.rst" index.rst
another2.rst 'another file.rst'
Note: Filepaths can be wrapped in quotes (single or double). This is especially useful for filepaths containing spaces.
conf.py:
rediraffe_redirects = {
"another.rst": "index.rst",
"another2.rst": "another.rst",
}
conf.py:
rediraffe_redirects = "redirects.txt"
rediraffe_branch = "main~1"
conf.py:
rediraffe_redirects = "redirects.txt"
rediraffe_template = "template.html"
template.html:
<html>
<body>
<p>Your destination is {{to_url}}</p>
</body>
</html>
A complex example can be found at tests/roots/ext/.
Rediraffe uses pytest for testing. To run tests:
python -m pip install -r test-requirements.txt
python -m pytest --headless
The --headless flag ensures that a browser window does not open during browser backed selenium testing.
FAQs
Sphinx Extension that redirects non-existent pages to working pages.
We found that sphinxext-rediraffe demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Four npm packages disguised as cryptographic tools steal developer credentials and send them to attacker-controlled Telegram infrastructure.
Security News
Ruby maintainers from Bundler and rbenv teams are building rv to bring Python uv's speed and unified tooling approach to Ruby development.
Security News
Following last week’s supply chain attack, Nx published findings on the GitHub Actions exploit and moved npm publishing to Trusted Publishers.