如何通过readthedocs构建中的脚本修改用斯芬克斯构建的文档
我正在尝试运行一个脚本来修改由Read托管的sphinx构建的文档(因为有些链接没有得到正确的处理)。当我试图在本地构建脚本时，脚本可以工作，但在读取文档生成时失败，或者更改不会传播到网站。
我试图运行的脚本非常简单，它替换了一些没有被sphinx标记表正确转换的html链接：
#!/bin/bash
# fix_table_links.sh
FILE="_build/html/api_reference.html"
if [[ "$1" != "" ]]; then
FILE="$1"
fi
sed -E 's/a href="(.*)\.md"/a href="\1\.html"/g' -i ${FILE}我的readthedocs.yml看起来像这样：
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# Optionally build your docs in additional formats such as PDF and ePub
formats: all
# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: docs/requirements.readthedocs.txt
build:
os: ubuntu-20.04
tools:
python: "3.8"
jobs:
post_build:
- echo "Running post-build commands."
- bash docs/fix_table_links.sh _readthedocs/html/api_reference.html有两种情况：
案例1)使用readthedocs.yml，构建失败，因为_readthedocs/html/api_reference.html不存在，尽管这个目录是文档声明将从这里上传的地方。此运行的一个示例失败是这里。
Case 2)如果我将readthedocs.yml的最终结果更改为bash docs/fix_table_links.sh docs/_build/html/api_reference.html，那么构建就会通过(例如这里)。但是这些链接并没有在rather站点上更新:它们仍然指向标记页面，而不是相应的HTML页面，所以它不能是上传到Read网站的版本。
仔细阅读文档，我不知道如何做到这一点。以前是否有人这样做过，或者更好地掌握了文档构建工作的读取方式？谢谢!
回答 1
Stack Overflow用户
发布于 2022-09-04 16:22:41
如果您愿意将脚本重写为Python函数，那么通过将脚本作为事件的事件处理程序进行连接，可以非常容易地做到这一点。
我做了一些类似的在我自己的一次回复中，除了我后处理一个.rst文件。它实际上并没有在RTD上使用，但我可以看到它在构建日志中有效。因此，它也可以对HTML文件进行后置处理，因为build-finished事件将在生成后发生。
首先，将脚本定义为conf.py中的一个函数。它需要有app和exception作为参数。
def replace_html_links(app, exception):
with open(FILE, 'r') as f:
html = f.read()
# stuff to edit and save the html然后定义或添加到setup函数中：
def setup(app):
app.connect('build-finished', replace_html_links)就这样！
https://stackoverflow.com/questions/73455350
复制
腾讯云开发者
