rtd-redirects 1.1.0

安装

需要Python 3.6及以上版本。

$ pip install rtd-redirects

使用

$ rtd-redirects project-name ./redirects.yml --username=honzajavorek

将定义在redirects.yml文件中的重定向上传到ReadTheDocs的project-name项目的重定向管理。

此工具使用ReadTheDocs的HTML界面（没有官方的重定向API），因此您需要提供用户名和密码。使用HTTPS将凭证传输到ReadTheDocs。

rtd-redirects 尝试实现幂等性，即您可以连续多次运行它，并且它应该始终得到相同的结果。如果有任何具有相同源路径的重定向，则工具将使用 redirects.yml 文件中定义的内容替换它们。不会影响与 redirects.yml 文件内容不冲突的现有重定向。

redirects.yml

目前只支持 页面重定向。文件的格式如下

redirects:
  # we've migrated from MkDocs to Sphinx
  "/example/": "/example.html"
  "/python/": "/python.html"

  # page removed in favor of section
  "/green.html": "/colors.html#green"

  # only for convenience
  "/praha.html": "/prague.html"

为什么是 YAML？因为它易于人类阅读，易于人类编写，最重要的是，它支持注释。重定向是 纠正，您应该记录为什么它们是必要的。

与 ReadTheDocs PRO 一起使用

如果您正在使用 RTD 的商业版（从 readthedocs.com 而不是 readthedocs.org），请在命令中指定 --pro 标志，如下所示

$ rtd-redirects project-name ./redirects.yml --username=honzajavorek --pro

还有一个相反的标志 --free，默认添加，因此可以省略

许可证：MIT

© 2017-? Honza Javorek mail@honzajavorek.cz

本作品许可协议为 MIT 许可证。