{"id":19931081,"url":"https://github.com/sphinx-contrib/redirects","last_synced_at":"2025-09-03T13:09:34.581Z","repository":{"id":65376644,"uuid":"105069363","full_name":"sphinx-contrib/redirects","owner":"sphinx-contrib","description":"A Sphinx extension for generating JavaScript-driven redirects for moved pages","archived":false,"fork":false,"pushed_at":"2024-10-08T17:07:44.000Z","size":19,"stargazers_count":9,"open_issues_count":2,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-28T21:33:35.618Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-09-27T21:05:22.000Z","updated_at":"2024-10-08T17:02:41.000Z","dependencies_parsed_at":"2025-05-03T10:44:49.030Z","dependency_job_id":null,"html_url":"https://github.com/sphinx-contrib/redirects","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/sphinx-contrib/redirects","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fredirects","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fredirects/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fredirects/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fredirects/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/redirects/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fredirects/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273447385,"owners_count":25107345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T23:06:01.649Z","updated_at":"2025-09-03T13:09:34.518Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"=======================\nsphinxcontrib-redirects\n=======================\n\nThis contrib extension, `sphinxcontrib.redirects`, provides a Sphinx extension\nfor generating JavaScript-driven redirects for moved pages. It currently only\nsupports the `html` builder (``sphinx.builders.html.SingleFileHTMLBuilder``).\n\n.. note::\n\n    The `sphinxext-rediraffe \u003chttps://pypi.org/project/sphinxext-rediraffe/\u003e`__\n    extension appears to provide many more features than this package and\n    should probably be preferred for new projects.\n\nUsage\n-----\n\nTo enable the extension, you should add it to your ``conf.py`` file::\n\n    extensions = [\n        'sphinxcontrib.redirects',\n        ...\n    ]\n\nThe extension relies on a *redirect file*. This defaults to ``redirects``\nwithin the source directory but it can be overridden. To override this value,\nadd the following to your ``conf.py`` file::\n\n    redirects_file = '\u003cpath to redirects file\u003e'\n\nThe *redirect file* is a simple space-separated file of ``old_path`` -\n``new_path`` pairs. These paths are relative to the source directory and should\ninclude their extension. For example, if you renamed the file ``test.rst`` to\n``testing.rst`` then you could write::\n\n    test.rst testing.rst\n\nThis works for files moved between directories too. If you moved a ``test.rst``\nto ``testing/index.rst`` instead, then you could write::\n\n    test.rst testing/index.rst\n\nFor examples, refer to the samples used in the `tests\n\u003ctests/roots\u003e`__.\n\nContributing\n------------\n\nFor information on contributing, refer to the `contributing guide\n\u003cCONTRIBUTING.rst\u003e`__.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fredirects","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fredirects","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fredirects/lists"}