sphinx-rerediraffe 0.0.1__tar.gz

sphinx_rerediraffe-0.0.1/LICENCE.rst

@@ -0,0 +1,20 @@
+Copyright (c) 2020, Vasista Vovveti
+Copyright (c) 2025, the Sphinx developers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sphinx_rerediraffe-0.0.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: sphinx-rerediraffe
+Version: 0.0.1
+Summary: Sphinx Extension that redirects non-existent pages to working pages
+Author-email: Vasista Vovveti <vasistavovveti@gmail.com>, JJ Coldiron <jj.coldiron@canonical.com>
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-Expression: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Plugins
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Sphinx :: Extension
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing
+Classifier: Topic :: Utilities
+License-File: LICENCE.rst
+Requires-Dist: Sphinx>=6.0
+Project-URL: Code, https://github.com/jahn-junior/sphinx-rerediraffe/
+Project-URL: Documentation, https://sphinxext-rediraffe.readthedocs.io/
+Project-URL: Download, https://pypi.org/project/sphinx-rerediraffe/
+Project-URL: Homepage, https://github.com/sphinx-doc/sphinx-rerediraffe/
+Project-URL: Issue tracker, https://github.com/sphinx-doc/sphinxext-rediraffe/issues
+
+    The sphinx-rerediraffe fork was published as a **temporary solution**. The changes
+    it introduces have already been proposed upstream
+    (`sphinx-doc/sphinxext-rediraffe#67
+    <https://github.com/sphinx-doc/sphinxext-rediraffe/pull/67>`__,
+    `sphinx-doc/sphinxext-rediraffe#68
+    <https://github.com/sphinx-doc/sphinxext-rediraffe/pull/68>`__).
+
+sphinx-rerediraffe
+==================
+
+.. image:: https://img.shields.io/pypi/v/sphinx-rerediraffe.svg
+   :target: https://pypi.org/project/sphinx-rerediraffe/
+   :alt: Package on PyPI
+
+.. image:: https://github.com/sphinx-doc/sphinx-rerediraffe/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/sphinx-doc/sphinx-rerediraffe/actions
+   :alt: Build Status
+
+.. image:: https://img.shields.io/badge/License-MIT-blue.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+Sphinx extension to redirect files
+
+.. image:: ./assets/rediraffe_logo.svg
+   :align: center
+
+This Sphinx extension redirects non-existent pages to working pages.
+Rediraffe can also check that deleted or 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
+============
+
+.. code-block:: sh
+
+   pip install sphinx-rerediraffe
+
+Usage
+=====
+
+See the `documentation`_.
+
+.. _documentation: https://sphinxext-rediraffe.readthedocs.io/en/latest/
+

sphinx_rerediraffe-0.0.1/README.rst

@@ -0,0 +1,53 @@
+    The sphinx-rerediraffe fork was published as a **temporary solution**. The changes
+    it introduces have already been proposed upstream
+    (`sphinx-doc/sphinxext-rediraffe#67
+    <https://github.com/sphinx-doc/sphinxext-rediraffe/pull/67>`__,
+    `sphinx-doc/sphinxext-rediraffe#68
+    <https://github.com/sphinx-doc/sphinxext-rediraffe/pull/68>`__).
+
+sphinx-rerediraffe
+==================
+
+.. image:: https://img.shields.io/pypi/v/sphinx-rerediraffe.svg
+   :target: https://pypi.org/project/sphinx-rerediraffe/
+   :alt: Package on PyPI
+
+.. image:: https://github.com/sphinx-doc/sphinx-rerediraffe/actions/workflows/test.yml/badge.svg
+   :target: https://github.com/sphinx-doc/sphinx-rerediraffe/actions
+   :alt: Build Status
+
+.. image:: https://img.shields.io/badge/License-MIT-blue.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: MIT
+
+Sphinx extension to redirect files
+
+.. image:: ./assets/rediraffe_logo.svg
+   :align: center
+
+This Sphinx extension redirects non-existent pages to working pages.
+Rediraffe can also check that deleted or 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
+============
+
+.. code-block:: sh
+
+   pip install sphinx-rerediraffe
+
+Usage
+=====
+
+See the `documentation`_.
+
+.. _documentation: https://sphinxext-rediraffe.readthedocs.io/en/latest/

sphinx_rerediraffe-0.0.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

sphinx_rerediraffe-0.0.1/docs/conf.py

@@ -0,0 +1,34 @@
+from __future__ import annotations
+
+import sphinx_rerediraffe
+
+copyright = (
+    '2020, FIRST',
+    '2025-%Y, the Sphinx developers',
+)
+
+version = release = sphinx_rerediraffe.__version__
+
+master_doc = 'index'
+project = 'sphinxext-rediraffe'
+
+exclude_patterns = ['_build']
+
+nitpicky = True
+
+html_theme = 'furo'
+html_logo = '../assets/rediraffe_logo_128.png'
+
+extensions = [
+    'sphinx.ext.intersphinx',
+    'sphinx_rerediraffe',
+]
+
+intersphinx_mapping = {
+    'sphinx': ('https://www.sphinx-doc.org/', None),
+}
+
+rediraffe_redirects = {
+    'other.rst': 'index.rst',
+    'other2.rst': 'other.rst',
+}

sphinx_rerediraffe-0.0.1/docs/index.rst

@@ -0,0 +1,214 @@
+===================
+sphinxext-rediraffe
+===================
+
+.. role:: code-py(code)
+   :language: Python
+
+This Sphinx extension redirects non-existent pages to working pages.
+Rediraffe can also check that deleted or 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
+============
+
+.. code-block:: sh
+
+   python -m pip install sphinxext-rediraffe
+
+Usage
+=====
+
+Just add ``sphinx_rerediraffe`` to the extensions list in :file:`conf.py`,
+
+.. code-block:: python
+
+   extensions = [
+      'sphinx_rerediraffe',
+   ]
+
+and set :confval:`rediraffe_redirects` to a dict or file of redirects.
+
+Diff Checker
+------------
+
+The diff checker ensures that deleted or renamed files in your git repo
+are in your redirects.
+
+To run the diff checker:
+
+1. Set :confval:`rediraffe_branch` and :confval:`rediraffe_redirects`
+   in :file:`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 :confval:`rediraffe_branch` and :confval:`rediraffe_redirects`
+   in :file:`conf.py`.
+2. Run the ``rediraffewritediff`` 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 :file:`conf.py` of your Sphinx project.
+
+.. confval:: rediraffe_branch
+   :type: :code-py:`str`
+   :default: :code-py:`''`
+
+   **Required** for the ``rediraffecheckdiff`` & ``rediraffewritediff`` builders.
+   The branch or commit to diff against.
+
+.. confval:: rediraffe_redirects
+   :type: :code-py:`str | dict[str, str]`
+
+   A filename or dict containing redirects.
+
+.. confval:: rediraffe_template
+   :type: :code-py:`str`
+   :default: :code-py:`None`
+
+   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,
+   meaning that this file may be generated as part of your build.
+
+   Variables available to :confval:`!rediraffe_template`:
+
+   ``from_file``
+     the file being redirected as written in :confval:`rediraffe_redirects`.
+   ``to_file``
+     the destination file that from_file is redirected to as written in
+     :confval:`rediraffe_redirects`.
+   ``from_url``
+     the path to ``from_url``'s html file (built by rediraffe) relative to the
+     :confval:`!outdir`.
+   ``to_url``
+     the path to ``to_url``'s built html file relative to the :confval:`!outdir`.
+   ``rel_url``
+     the relative path from ``from_url`` to ``to_url``.
+
+.. confval:: rediraffe_auto_redirect_perc
+   :type: :code-py:`int`
+   :default: :code-py:`100`
+
+   Only used by the ``rediraffewritediff`` builder.
+   The percentage as an integer representing the accuracy required before
+   auto redirecting with the ``rediraffewritediff`` builder.
+
+.. confval:: rediraffe_dir_only
+   :type: :code-py:`bool`
+   :default: :code-py:`False`
+
+   Whether to include ``/index.html`` in destination URLs when using the ``dirhtml``
+   builder.
+
+Example Config
+==============
+
+redirects only (file)
+---------------------
+
+:file:`conf.py`:
+
+.. code-block:: python
+
+   rediraffe_redirects = 'redirects.txt'
+
+:file:`redirects.txt`:
+
+.. code-block:: text
+
+   # 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)
+---------------------
+
+:file:`conf.py`:
+
+.. code-block:: python
+
+   rediraffe_redirects = {
+       'another.rst': 'index.rst',
+       'another2.rst': 'another.rst',
+   }
+
+redirects + diff checker
+------------------------
+
+:file:`conf.py`:
+
+.. code-block:: python
+
+   rediraffe_redirects = 'redirects.txt'
+   rediraffe_branch = 'main~1'
+
+redirects with jinja template
+-----------------------------
+
+:file:`conf.py`:
+
+.. code-block:: python
+
+   rediraffe_redirects = 'redirects.txt'
+   rediraffe_template = 'template.html'
+
+:file:`template.html`:
+
+.. code-block:: html
+
+   <html>
+     <body>
+       <p>Your destination is {{to_url}}</p>
+     </body>
+   </html>
+
+A complex example can be found at :file:`tests/roots/ext/`.
+
+Testing
+=======
+
+Rediraffe uses pytest for testing.
+To run tests:
+
+1. Install this package
+2. Install test dependencies
+
+   .. code-block:: sh
+
+      python -m pip install --group test
+
+3. Navigate to the tests directory and run
+
+   .. code-block:: sh
+
+      python -m pytest --headless
+
+The ``--headless`` flag ensures that a browser window does not open
+during browser backed selenium testing.

sphinx_rerediraffe-0.0.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

sphinx_rerediraffe-0.0.1/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["flit_core>=3.12"]
+build-backend = "flit_core.buildapi"
+
+# project metadata
+[project]
+name = "sphinx-rerediraffe"
+description = "Sphinx Extension that redirects non-existent pages to working pages"
+readme = "README.rst"
+urls.Code = "https://github.com/jahn-junior/sphinx-rerediraffe/"
+urls.Documentation = "https://sphinxext-rediraffe.readthedocs.io/"
+urls.Download = "https://pypi.org/project/sphinx-rerediraffe/"
+urls.Homepage = "https://github.com/sphinx-doc/sphinx-rerediraffe/"
+urls."Issue tracker" = "https://github.com/sphinx-doc/sphinxext-rediraffe/issues"
+license = "MIT"
+license-files = [
+    "LICENCE.rst",
+]
+requires-python = ">=3.11"
+authors = [
+    {name = "Vasista Vovveti", email = "vasistavovveti@gmail.com"},
+    {name = "JJ Coldiron", email = "jj.coldiron@canonical.com"},
+]
+
+# Classifiers list: https://pypi.org/classifiers/
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Plugins",
+    "Environment :: Web Environment",
+    "Framework :: Sphinx :: Extension",
+    "Intended Audience :: Developers",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python",
+    "Topic :: Documentation :: Sphinx",
+    "Topic :: Documentation",
+    "Topic :: Software Development :: Documentation",
+    "Topic :: Text Processing",
+    "Topic :: Utilities",
+]
+dependencies = [
+    "Sphinx>=6.0",
+]
+dynamic = ["version"]
+
+[dependency-groups]
+docs = [
+    "furo>=2024",
+    "sphinx~=8.2.0",
+]
+lint = [
+    "ruff==0.13.2",
+]
+package = [
+    "betterproto==2.0.0b6",  # resolution fails without betterproto
+    "build",
+    "pypi-attestations==0.0.27",
+    "twine>=6.1",
+]
+test = [
+    "pytest",
+    "seleniumbase",
+]
+
+[tool.flit.module]
+name = "sphinx_rerediraffe"
+
+[tool.flit.sdist]
+include = [
+    # Documentation
+    "docs/",
+    # Tests
+    "tests/",
+    "tox.ini",
+]
+exclude = [
+    "docs/_build",
+]
+
+[tool.uv]
+default-groups = "all"

sphinx_rerediraffe-0.0.1/sphinx_rerediraffe/__init__.py

@@ -0,0 +1,25 @@
+from sphinx.util.typing import ExtensionMetadata
+from sphinx.application import Sphinx
+from sphinx_rerediraffe.callback import CheckRedirectsDiffBuilder, WriteRedirectsDiffBuilder, build_redirects
+
+__version__ = '0.0.1'
+
+def setup(app: Sphinx) -> ExtensionMetadata:
+    app.add_config_value('rediraffe_redirects', None, None)
+    app.add_config_value('rediraffe_branch', '', None)
+    app.add_config_value('rediraffe_template', None, None)
+    app.add_config_value('rediraffe_auto_redirect_perc', 100, None)
+    app.add_config_value('rediraffe_dir_only', False, 'env')
+
+    app.add_builder(CheckRedirectsDiffBuilder)
+    app.add_builder(WriteRedirectsDiffBuilder)
+    app.connect('build-finished', build_redirects)
+
+    return {
+        'version': __version__,
+        'env_version': 1,
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }
+
+__all__ = ['__version__', 'setup']