PHPDocumentor中RST文档内部链接缺失问题求助
问题排查:phpDocumentor中RST文档内链接失效
以下是可能导致:doc:链接不生效的原因及解决办法:
文件名/路径不匹配
:doc:指令的参数需要是目标页面的文件路径(不带.rst后缀),而非页面显示的标题。比如目标文件是another_page.rst,要写:doc:another_page;如果文件在子目录`guides/`下,就写`:doc:`guides/another_page。你现在写的:doc:Another Page``是页面标题,phpDocumentor找不到对应文件,自然不会生成链接。未正确配置文档结构
检查你的phpdoc.dist.xml,确保<guides>节点指定了正确的源目录,且目标RST文件被包含在文档的toctree中。比如要在主页面用.. toctree::列出所有关联页面,让phpDocumentor识别到文件间的关联:.. toctree:: :hidden: another_page缓存干扰
清理phpDocumentor的生成缓存(默认是build/目录或.phpdoc/cache),然后重新执行生成命令,避免旧缓存导致的链接异常。指令语法细节
确保:doc:指令的格式正确,没有多余空格或符号。如果要自定义链接文本,应该用:doc:自定义文本 <文件路径>``的格式,比如:Link to another page :doc:`Another Page <another_page>`
内容的提问来源于stack exchange,提问作者vogomatix
相关产品推荐
相关产品推荐

