Skip to main content

sphinxext-rediraffe

ci Code style: black

Sphinx Extension to redirect files

Rediraffe

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.

Installation

python -m pip install sphinxext-rediraffe

Usage

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

Diff Checker

The diff checker ensures that deleted/renamed files in your git repo are in your redirects.

To run the diff checker,

  1. Set rediraffe_branch and rediraffe_redirects in conf.py.
  2. Run the rediraffecheckdiff builder.

Auto Redirect 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:

  1. Set rediraffe_branch and rediraffe_redirects in conf.py.
  2. Run the redireaffewritediff builder.

Note: The auto redirect builder only works with a configuration file. Note: Deleted files cannot be added to your redirects file automatically.

Options

These values are placed in the conf.py of your sphinx project.

  • rediraffe_branch

    • Required for the rediraffecheckdiff and rediraffewritediff builders. The branch or commit to diff against.
  • rediraffe_redirects

    • Required. A filename or dict containing redirects
  • rediraffe_template

    • Optional. A jinja template to use to render the inserted redirecting files. If not specified, a default template will be used. This template will only be accessed after the html/htmldir builder is finished; Therefore, this file may be generated as part of your build.
    • variables available to 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

    • Optional. Only used by the rediraffewritediff builder. The percentage as an integer representing the accuracy required before auto redirecting with the rediraffewritediff builder. The default is 100.

Example Config

redirects only (file)

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.

redirects only (dict)

conf.py:

rediraffe_redirects = {
    "another.rst": "index.rst",
    "another2.rst": "another.rst",
}

redirects + diff checker

conf.py:

rediraffe_redirects = "redirects.txt"
rediraffe_branch = "master~1"

redirects with jinja template

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/.

Testing

Rediraffe uses pytest for testing. To run tests:

  1. Install this package
  2. Install test dependencies
    python -m pip install -r test-requirements.txt
    
  3. Navigate to the tests directory and run
    python -m pytest --headless
    

The --headless flag ensures that a browser window does not open during browser backed selenium testing.

Metadata

Release files for sphinxext-rediraffe 0.2.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxext-rediraffe 0.2.5
File Size Uploaded Provenance Actions
sphinxext-rediraffe-0.2.5.tar.gz 7.9 kB Without provenance Details for sphinxext-rediraffe-0.2.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for sphinxext-rediraffe 0.2.5
File Interpreter ABI Platform Actions
sphinxext_rediraffe-0.2.5-py3-none-any.whl Python 3 none any Details for sphinxext_rediraffe-0.2.5-py3-none-any.whl

Total release size: 16.1 kB

Release files / sphinxext-rediraffe-0.2.5.tar.gz

Download URL sphinxext-rediraffe-0.2.5.tar.gz
Size 7.9 kB
Tags Source
SHA-256 checksum
How to use checksums
a17287cdee7763341b91762879e042b33a4916d6a2fc6d2f97a18107325bd2cc
BLAKE2b-256 checksum
How to use checksums
e20b3b1b222600326fd8c249bacbf971316625bb0a8457738ee067b875e8f702
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

Release files / sphinxext_rediraffe-0.2.5-py3-none-any.whl

Download URL sphinxext_rediraffe-0.2.5-py3-none-any.whl
Size 8.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7b706284d20602acecc1783cc58c8d0543937af1ee53f912bfdc4b258a7e649a
BLAKE2b-256 checksum
How to use checksums
f0416ef2c6710c15eacf4e1fb469d0dbff73c6034cde1b0c5c66ac845c0160a7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.6

Security for sphinxext-rediraffe 0.2.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page