sphinxcontrib-redirects 0.1.0

用法

要启用此扩展，您应将其添加到您的 conf.py 文件

extensions = [
    'sphinxcontrib.redirects',
    ...
]

此扩展依赖于一个 重定向文件。默认情况下，此文件位于源目录中的 redirects，但它可以被覆盖。要覆盖此值，请将以下内容添加到您的 conf.py 文件中

redirects_file = '<path to redirects file>'

重定向文件 是一个简单的空格分隔的 old_path - new_path 对的文件。这些路径相对于源目录，应包括它们的扩展名。例如，如果您将文件 test.rst 重命名为 testing.rst，则可以编写

test.rst testing.rst

这也适用于在不同目录之间移动的文件。如果您将 test.rst 移动到 testing/index.rst，则可以编写

test.rst testing/index.rst

有关示例，请参阅 tests 中使用的示例。

贡献

有关贡献的信息，请参阅 贡献指南。