首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

无法使用推荐标记将README.md的相对路径添加到Sphinx

在使用Sphinx构建文档时,推荐标记(.. seealso::)用于在文档中引用其他相关文档或资源。然而,由于Sphinx的限制,无法直接使用推荐标记将README.md的相对路径添加到Sphinx。

解决这个问题的一种方法是将README.md转换为reStructuredText(.rst)格式,然后在Sphinx文档中使用推荐标记引用转换后的文件。可以使用工具如pandoc来进行转换。

以下是一种可能的解决方案:

  1. 使用pandoc将README.md转换为reStructuredText格式。假设你已经安装了pandoc,可以使用以下命令进行转换:
  2. 使用pandoc将README.md转换为reStructuredText格式。假设你已经安装了pandoc,可以使用以下命令进行转换:
  3. 将生成的README.rst文件移动到Sphinx文档目录的适当位置。
  4. 在Sphinx文档中使用推荐标记引用转换后的文件。例如,在你想引用README的地方,可以添加以下内容:
  5. 在Sphinx文档中使用推荐标记引用转换后的文件。例如,在你想引用README的地方,可以添加以下内容:
  6. 在Sphinx文档的适当位置添加一个引用标签,以便在推荐标记中引用。在你想引用README的地方,可以添加以下内容:
  7. 在Sphinx文档的适当位置添加一个引用标签,以便在推荐标记中引用。在你想引用README的地方,可以添加以下内容:

这样,当你构建Sphinx文档时,推荐标记将会正确地引用转换后的README文件。

请注意,这只是一种解决方案,你也可以根据自己的需求和工具链进行调整。此外,腾讯云提供了一系列云计算产品,可以根据具体需求选择适合的产品。你可以访问腾讯云官方网站(https://cloud.tencent.com/)了解更多关于腾讯云的产品和服务。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

ReStructuredText 文档编写全攻略编写文档说明

采用是 markdown 编写文档,格式不同,但组织方式和 rst 文档组织方式很相似,可以对比着感受下,选择适合方式编写文档 编写文档整体流程 rst 只是一种标记语言,需要使用恰当工具,... rst 格式文件转换成 html 等格式文件,方便托管在服务器上,进行访问,依赖工具有:sphinx sphinx 介绍 sphinx 是一个基于python文档生成工具,许多 python...,遇到问题再针对性查找: 比如:如何在文档内提供下载链接,点击链接就能进行下载 gitbook使用 Gitbook 和 sphinx 有很多相似之处: 自动生成文档 使用标记语言:gitbook...使用 markdown、sphinx 使用 rst 文档结构组织方式很相似:gitbook 是 SUMMARY.md 、sphinx 使用文件是 index.rst 安装 gitbook 客户端...我比较喜欢 JetBrains 旗下开发工具,几乎我要使用IDE 都从其中进行选择,风格很相似,会一款了,其他几乎都会用,而且支持插件也很多,比如学习 markdown 标记语言,就有可是化插件

5.7K31

Markdown 拓展-使用 vue.press 生成网站

一个 VuePress 站点本质上是一个由 Vue在新窗口打开 和 Vue Router在新窗口打开 驱动单页面应用 (SPA)。 路由会根据你 Markdown 文件相对路径来自动生成。...{ "scripts": { "docs:dev": "vuepress dev docs", "docs:build": "vuepress build docs" } } 默认临时目录和缓存目录添加到...─ contributing.md └─ README.md docs 目录作为你 sourceDir ,例如你在运行 vuepress dev docs 命令。...此时,你 Markdown 文件对应路由路径为: 相对路径 路由路径 /README.md / /contributing.md /contributing.html /guide/README.md...目录 如果你想要把当前页面的目录添加到 Markdown 内容中,你可以使用 [[toc]] 语法。 代码块 下列代码块扩展是在 Node 端进行 Markdown 解析时候实现

1.5K10
  • 新手如何发布第一个Python项目开源包?这里有一份详细指南

    要在项目中添加许可证,只需参照以下链接中步骤, LICENSE 文件添加到项目库中根目录即可:https://help.github.com/en/articles/adding-a-license-to-a-repository...(但强烈推荐),但是如果你现在马上想发布你包,可以直接跳到第 7 步。...(见下面的截图) readme 文件中标签(推荐一篇如何使用标签好文章:https://medium.freecodecamp.org/how-to-use-badges-to-stop-feeling-like-a-noob-d4e6600d37d2...sphinx 和 readthedocs 相关教程:https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html...你可以按照以下步骤添加到社区:https://conda-forge.org/#add_recipe,然后你会被添加到 conda forge Github 组织中,并能够非常轻松地维护你包,然后任何人都可以通过运行

    80920

    新手如何发布第一个Python项目开源包?

    要在项目中添加许可证,只需参照以下链接中步骤, LICENSE 文件添加到项目库中根目录即可:https://help.github.com/en/articles/adding-a-license-to-a-repository...(但强烈推荐),但是如果你现在马上想发布你包,可以直接跳到第 7 步。...(见下面的截图) readme 文件中标签(推荐一篇如何使用标签好文章:https://medium.freecodecamp.org/how-to-use-badges-to-stop-feeling-like-a-noob-d4e6600d37d2...sphinx 和 readthedocs 相关教程:https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html...你可以按照以下步骤添加到社区:https://conda-forge.org/#add_recipe,然后你会被添加到 conda forge Github 组织中,并能够非常轻松地维护你包,然后任何人都可以通过运行

    1.1K20

    新手如何发布第一个Python项目开源包?这里有一份详细指南

    要在项目中添加许可证,只需参照以下链接中步骤, LICENSE 文件添加到项目库中根目录即可:https://help.github.com/en/articles/adding-a-license-to-a-repository...(但强烈推荐),但是如果你现在马上想发布你包,可以直接跳到第 7 步。...(见下面的截图) readme 文件中标签(推荐一篇如何使用标签好文章:https://medium.freecodecamp.org/how-to-use-badges-to-stop-feeling-like-a-noob-d4e6600d37d2...sphinx 和 readthedocs 相关教程:https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html...你可以按照以下步骤添加到社区:https://conda-forge.org/#add_recipe,然后你会被添加到 conda forge Github 组织中,并能够非常轻松地维护你包,然后任何人都可以通过运行

    1.3K30

    详细指南 | 如何在Github发布Python开源包

    要在项目中添加许可证,只需参照以下链接中步骤, LICENSE 文件添加到项目库中根目录即可:https://help.github.com/en/articles/adding-a-license-to-a-repository...(但强烈推荐),但是如果你现在马上想发布你包,可以直接跳到第 7 步。...(见下面的截图) readme 文件中标签(推荐一篇如何使用标签好文章:https://medium.freecodecamp.org/how-to-use-badges-to-stop-feeling-like-a-noob-d4e6600d37d2...sphinx 和 readthedocs 相关教程:https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html...你可以按照以下步骤添加到社区:https://conda-forge.org/#add_recipe,然后你会被添加到 conda forge Github 组织中,并能够非常轻松地维护你包,然后任何人都可以通过运行

    1.8K20

    使用VuePress 搭建个人博客

    VuePress 目录结构 VuePress 遵循 「“约定优于配置”」 原则,推荐目录结构如下: . ├── blog │ ├── .vuepress (可选) │ │ ├── components...比如此目录下文件路由地址如下: 文件相对路径 页面路由地址 /README.md / /_post/README.md /_post/ /_post/about.md /_post/about.html.../source/_post/intro-vuepress.html 推荐使用 permalink 指定文章永久链接,可以使用全局配置来向所有页面应用永久链接: // .vuepress/config.js...这里推荐安装: 安装 使用以下命令安装 yarn add -D @vuepress/plugin-google-analytics # OR npm install -D @vuepress/plugin-google-analytics...使用 ga 配置添加到配置文件 module.exports = { plugins: [ [ '@vuepress/google-analytics', {

    99620

    reStructuredtext快速入门

    在必要时候,.rst文件可以被转化成PDF或者HTML格式,也可以有Sphinx转化为LaTex,man等格式,现在被广泛用于程序文档撰写。...*text*:使用一个星号包裹文本表示斜体 **text**:使用两个星号包裹文本表示粗体 ``text``:使用两个反引号包裹文本表示代码块 如果星号或反引号出现在文本会对行内标记分隔符引起混淆...也是reST 扩展规则, 在 Sphinx 经常被用到。...图像 reST 支持图像指令, 如下 .. image:: gnu.png (选项) 这里给出文件名( gnu.png) 必须是源文件相对路径,如果是绝对路径则以源目录为根目录....Sphinx 会自动图像文件拷贝到输出目录子目录里,( 输出HTML时目录为 _static ) 注释 有明确标记块但又不是有效结构标记标记 (像上面的尾注)都被视为注释,例如: ..

    1.5K20

    Sphinx补篇

    ,在阅读起来可能有一丝割裂感.但是在学习感觉上是,由浅入深,由浅入深感觉,以下所有文章都是这样........ ---- 在说一下Sphinx是一种工具,可以一组reStructuredText...就像这样 ---- 在命令选项板(Ctrl-Shift-P或Cmd-Shift-P)中输入命令,并在表语法中使用光标位置。当前表格将被格式化。或者,您可以所有表语法格式化为打开文本。...那时,标记语言是自动确定。...和文档说一样 ? 有自动补全就舒服 ? 一个reStructuredText标记元素,它可以标记具有特殊含义内容块。指令不仅由docutils提供,而且Sphinx和自定义扩展可以添加自己指令。...相关配置项已经由 sphinx-quickstart 在初始化时写入 conf.py (使用 Py 标准注释 # 一些备选项,事先注释了) 要修订对应配置,只要先消除对应行注释,并修订参数值就好.

    1.2K10

    使用restructedtext编写xresloader文档

    这次拖这么长时间主要是因为最近学习了一个新文本标记语言 – ReStructuredText 。并且重新整理了Excel导表工具-xresloader工具集文档,写文档真是好废好废时间啊。...然后现在有比较容易上手readthedocs来托管文档,和github集成也还不错。所以我打算把一些项目的文档也迁移上去。毕竟 README.md 还是弱了些。...但是使用 Markdown 写文档还是略麻烦,特别是涉及跨文档引用和多行表格时候,而且 Markdown 各个平台组件和扩展还都不一样,没有统一标准。...所以我干脆用了Noto字体中文等宽字体来显示,这下总算是对齐了。不过Noto中文等宽字体英文显示看起来很是怪异。因为它保证是中文一半宽度。...ReStructuredText官方生成工具是sphinxsphinx还能自己指定主题,分析目录,生成静态搜索索引。这个 静态搜索索引 真的是非常实用,这样生成文档也有搜索功能了。

    48810

    sphinx入门指南【2】 toctree指令详解

    reST本身并不支持同时与多个文档进行交互,或者说一个文档保存到多个文件中。Sphinx提供了自定义指令toctree来支持实现这个功能。..... toctree:: 这个指令会在当前位置插入文档目录树。关联文档路径可以使用相对路径或者绝对路径。 相对路径是指相对于toctree指令所在文件路径。绝对路径是相对于源文件目录路径。..... toctree:: intro All about strings datatypes 第二行链接到strings文档,但是使用"All about strings..... toctree:: :includehidden: doc_1 doc_2 最后要注意是,所有源目录中文档必须出现在toctree指令中,否则sphinx会告警。...特殊名字 下面这些名字在sphinx中已经被使用,因此我们文档名尽量不要使用: genindex modindex search 以_开头名字

    3.6K40

    如何在CentOS 7上安装和配置Sphinx

    没有服务器同学可以在这里购买,不过我个人更推荐使用免费腾讯云开发者实验室进行试验,学会安装后再购买服务器。 一个可使用sudo权限非root用户。 MySQL安装在您服务器上。...第2步 - 创建测试数据库 在这里,我们将使用随包提供SQL文件中示例数据来设置数据库。这将允许我们测试Sphinx搜索是否在以后工作。 让我们示例SQL文件导入数据库。...已经提供了最小配置,但我们提供一个新示例配置文件供您使用并解释每个部分,以便您以后可以自定义。 首先,移动现有sphinx.conf文件。...第4步 - 管理索引 在此步骤中,我们Sphinx索引添加数据,并通过cron确保索引保持最新数据。 首先,使用我们之前创建配置数据添加到索引。...crontab -e 以下Cron作业每小时运行一次,并使用我们之前创建配置文件新数据添加到索引中。将其复制并粘贴到文件末尾,然后保存并关闭该文件。

    2.8K23

    如何在Ubuntu 16.04上安装和配置Sphinx

    没有服务器同学可以在这里购买,不过我个人更推荐使用免费腾讯云开发者实验室进行试验,学会安装后再购买服务器。 一个可使用sudo权限非root用户。 MySQL安装在您服务器上。...第2步 - 创建测试数据库 接下来,我们将使用随包提供SQL文件中示例数据来设置数据库。这将允许我们测试Sphinx搜索是否在以后工作。 让我们示例SQL文件导入数据库。...我们提供一个示例配置文件供您使用,并解释每个部分,以便您以后可以自定义。 首先,创建sphinx.conf文件。...第4步 - 管理索引 在此步骤中,我们Sphinx索引添加数据,并通过cron确保索引保持最新数据。 首先,使用我们之前创建配置数据添加到索引。...后面的cronjob每小时运行一次,并使用我们之前创建配置文件新数据添加到索引中。将其复制并粘贴到文件末尾,然后保存并关闭该文件。

    3.2K00

    【git系列】简单入门git命令一

    LICENSE.txt 说明: 新添加未跟踪文件前面有 ?? 标记; 新添加到暂存区中文件前面有 A 标记; 修改过文件前面有M标记。...跟踪新文件或者暂存已修改文件 命令:git add 参数:git add命令使用文件或目录路径作为参数;如果参数是目录路径,该命令递归地跟踪该目录下所有文件。...提交更新 暂存区文件提交到本地仓库中。使用git commit. commit 命令后添加 -m 选项,提交信息与命令放在同一行。...@@ -8,6 +8,8 @@ + + #### 项目简介 示例2: 示例1提交,然后再次对README.md 文件修改,然后添加到暂存区,使用git diff --staged...add ,则将文件添加到暂存区; 使用命令git commit -m ‘’,则是暂存区文件提交到本地仓库(版本历史中存在记录)。

    47510

    几款文档框架:Mkdocs、Sphinx、Teadocs、docsify

    文档框架 同博客框架 WordPress、Hexo 等一样,Web 文档也有自己框架,如比如 Java Javadoc,Python pydoc,以及Python-sphinx。...对于 Python 有专门文档标记语言 reStructuredText(RST),常见 Python 各种库和工具帮助文档基本都是用 RST 所写。...同时也支持 README.md 作为首页,会将其转化为 index.html。...如果 index.md 和 README.md 同时存在,忽略 README.md 非 markdown 文件 markdown 文件,即扩展名为 md 文件,会被转化为 html。...不要担心文件名,因为生成站点时会自动换成 html 文件路径 生成站点 执行mkdocs build命令,生成站点,点击index.html即可 mkdocs build 使用sphinx 安装sphinx

    1.5K20
    领券