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

我可以使用conf.py在sphinx文档中显示版本历史表吗?

是的,您可以使用conf.py在Sphinx文档中显示版本历史表。

Sphinx是一个用于文档生成的工具,它支持使用conf.py文件进行配置。要在Sphinx文档中显示版本历史表,您可以按照以下步骤操作:

  1. 打开您的Sphinx项目中的conf.py文件。
  2. 在文件中找到并编辑"extensions"部分,确保sphinx.ext.autodoc和sphinx.ext.viewcode扩展已启用。这两个扩展将帮助您生成API文档和源代码链接。
  3. 在文件中找到并编辑"html_context"部分,添加一个名为"versions"的字典。该字典将包含您的版本历史信息。 例如:html_context = { 'versions': { '1.0': 'https://docs.example.com/1.0', '2.0': 'https://docs.example.com/2.0', '3.0': 'https://docs.example.com/3.0', } }在上述示例中,我们定义了三个版本(1.0、2.0和3.0),并为每个版本提供了相应的文档链接。
  4. 保存并关闭conf.py文件。
  5. 在您的Sphinx项目中重新生成文档。您可以使用以下命令:sphinx-build -b html sourcedir builddir其中,sourcedir是您的Sphinx源代码目录,builddir是生成的HTML文档输出目录。

生成的文档将包含一个版本选择器,用户可以选择不同的版本查看文档。每个版本的文档页面将包含一个版本历史表,其中列出了可用的版本和相应的文档链接。

这是一个使用腾讯云的产品示例链接:腾讯云文档。请注意,这只是一个示例链接,您可以根据您的实际情况选择适合的腾讯云产品和文档链接。

希望这个答案对您有帮助!如果您有任何其他问题,请随时提问。

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

相关·内容

Sphinx初尝

/tutorial.html 我们实现上述的目的,使用的是Sphinx: Sphinx 是一种文档工具,它可以令人轻松的撰写出清晰且优美的文档, 由 Georg Brandl BSD 许可证下开发....下面列出了其良好特性,这些特性Python官方文档均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages(...您可以根路径中使用目录“ _build”,也可以单独使用 根路径的“源”和“构建”目录。 有一些提示,自己摁 项目名称将在生成的文档的多个位置出现。...例如,对于Python文档,这可能类似于2.6.0rc1。 显示错误,很智能的提醒用.\这种语法 可以输出的类型,有一些并不可以输出.缺少东西 ....pip install recommonmark pip install sphinx_rtd_theme 安装好,conf.py修改下列两个配置: source_suffix = ['.rst'

1.6K20

Sphinx+gitee+Read the Docs搭建在线文档系统

Sphinx是一个功能强大的文档生成器,具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统,相比github,有着更快的访问速度 Read the Docs是一个在线文档托管服务, 你可以从各种版本控制系统中导入文档...1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinxwindows的命令行输入下面的命令 pip install -i...还有一种HTTP服务的方式,可以浏览器器通过ip地址来查看,该方式需要安装自动build工具: pip install -i https://pypi.tuna.tsinghua.edu.cn/simple...'] 注:支持markdown后,文档文件可以使用markdown格式,但文档的配置文件index.rst还要使用reST格式 3.2 修改文档显示结构 3.2.1 index文件分析 修改文档结构,...6 搭建过程演示视频 本文的模板工程已整理至的gitee ? 点击https://gitee.com/xxpcb/sphinx-demo,可以直达此项目的gitee仓库~

1.8K30

使用 Sphinx 给 Python 项目生成【Read the Docs】在线文档

“Read the Docs” 提供自动构建,版本控制和在线托管,来简化软件文档的发布和管理。...它使用 Sphinx 生成 html 静态页面,通过 github 账户授权,本地项目 push 到 github 仓库时,自动完成文档的生成和在线更新。...1.3 两者关系 可以简单认为 Sphinx 是一个独立的文档生成工具,可以支持不同的主题;而 Read the Docs 是一个免费的在线文档托管平台,它使用 Sphinx 作为文档生成工具,并提供自己的主题...docs 分支: git checkout -b docs 创建子目录 docs: mkdir docs 3.2 使用 sphinx-quickstart 初始化文档 进入 docs 目录,运行命令...使用 GitHub 账号授权登陆。”Read the Docs” 会自动同步 GitHub 所有项目,并以列表显示出来,选择项目 imgkernel ,点击右边的按钮 ➕ ,导入项目。

3.2K20

Sphinx快速制作文档

简介 Sphinx 是一种文档工具,它可以令人轻松的撰写出清晰且优美的文档, 由 Georg Brandl BSD 许可证下开发....下面列出了其良好特性,这些特性Python官方文档均有体现: 丰富的输出格式: 支持 HTML (包括 Windows 帮助文档), LaTeX (可以打印PDF版本), manual pages(...我们需要在终端输入下列命令进行安装: pip install sphinx 创建Sphinx项目 创建一个用于存放文档的文件夹,然后该文件夹路径下运行下列命令快速生成Sphinx项目: sphinx-quickstart...Sphinx 主要功能是使用 reStructuredText, 把许多文件组织成一份结构合理的文档. toctree指令初始值如下: .. toctree:: :maxdepth: 2 你可以...pip install recommonmark pip install sphinx_rtd_theme 安装好,conf.py修改下列两个配置: source_suffix = ['.rst'

1.8K60

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

采用的是 markdown 编写文档,格式不同,但组织方式和 rst 文档的组织方式很相似,可以对比着感受下,选择适合的方式编写文档 编写文档的整体流程 rst 只是一种标记语言,需要使用恰当的工具,...将 rst 格式的文件转换成 html 等格式的文件,方便托管服务器上,进行访问,依赖的工具有:sphinx sphinx 介绍 sphinx 是一个基于python的文档生成工具,许多 python...优势在于: 输出格式丰富 文档组织结构清晰 语法高亮 最大的优势是可以像管理代码一样的管理文档:即文档即代码 安装:默认需要提前安装 python pip install sphinx or easy_install...:gitbook 使用 markdown、sphinx 使用 rst 文档的结构组织方式很相似:gitbook 是 SUMMARY.md 、sphinx 使用的文件是 index.rst 安装 gitbook...比较喜欢 JetBrains 旗下的开发工具,几乎使用的IDE 都从其中进行选择,风格很相似,会一款了,其他的几乎都会用,而且支持的插件也很多,比如学习 markdown 标记语言,就有可是化插件

5.5K31

Sphinx补篇

也就是说,如果您的目录包含一堆reST格式的文档(可能还有文档的子目录)以及),Sphinx可以生成结构良好的HTML文件(在其他目录),以方便浏览和导航。...但是从同一来源,它还可以生成LaTeX文件,也可以将其编译为文档的PDF版本,或者直接使用rst2pdf编译为PDF文件。 ?...就是这个文件,事实上这个文件也可以是txt文件.但是就写rst,咋啦 ? 就像这样 ---- 命令选项板(Ctrl-Shift-P或Cmd-Shift-P)输入命令,并在表语法中使用光标位置。...#build-config 基本配置 之前提及我们使用 conf.py 脚本来控制 Sphinx 怎么处理文档....相关配置项已经由 sphinx-quickstart 初始化时写入 conf.py (使用 Py 的标准注释 # 将一些备选项,事先注释了) 要修订对应配置,只要先消除对应行的注释,并修订参数值就好.

1.1K10

5步搭建一个测试文档管理网站

Sphinx默认使用reStructuredText作为文档写作语言, 当然也可以通过模块支持其他格式,比如我喜欢的MarkDown格式。...编写第一个文档 现在开始就可以创建真正的文档了,具体需要3步: 1.source目录下创建一个.rst的文件,如:hello.rst2.文件内容为rst格式文本3.修改source/index.rst...修改html模板 现在你已经可以开始编写发布你的文章和文档了,只是使用的是默认的写作语言和默认的html模板,如果你希望使用额外的支持,可以选择性的执行下面2个步骤。...除了默认html模板外,你当然可以自定义模板了;除此之外还有一个比较流行的模板 -- readthedoc官网使用的模板。其配置方式只要修改一下source/conf.py文件即可。...对而言,2个模板都是可以接受的;第一个模板也有很多开源工具在用,比如:flask官网;第二个更是readthedoc的主题模板。 5.

76020

Python利用sphinx构建个人博客

一、基础概念 利用sphinx+pandoc+github+readthedocs构建个人博客 Sphinx: 是一个基于ReStructuredText的文档生成工具,可以令人轻松的撰写出清晰且优美的文档...Read the Docs是一个在线文档托管服务,可以从各种版本控制系统中导入文档。支持webhooks,当你提交代码时,文档将被自动构建。...我们可以使用这个工具写文档、记笔记等。...#文件夹,当你执行make html的时候,生成的html静态文件都存放在这里 ├── make.bat ├── Makefile #编译文件用 make 命令时,可以使用这些指令来构建文档输出...└── source #文件夹,文档源文件全部应全部放在source根目录下 ├── conf.py #Sphinx 的配置文件 ├── index.rst

2.2K21

使用python编写量子线路打印的简单项目,并使用Sphinx自动化生成API文档

量子线路背景知识 在前面几篇博客,有介绍过使用开源量子计算编程框架ProjectQ进行量子线路的绘制,会给我们输出一个tex格式的线路图,文章可以直接使用。...而文档的第二个部分则是具体到每个函数、每个类的接口文档开发阶段,我们先按照格式要求写好注释文档,然后通过开源工具Sphinx可以自动化的生成API接口文档。 ?...如果不需要使用read_the_docs格式也可以不安装后者,只是后者python的开源项目中还是最常用的一种文档格式,并且可以配合read_the_docs网站进行API文档的托管,因此推荐使用。...需要注意的是,如果相关的类或者函数是受保护的类型,那么sphinx生成的文档是不会显示的(构造过程自动忽略)。...总结概要 在这篇文章,我们主要通过一个量子线路打印的python项目介绍,也顺带通过sphinx将python项目的注释文档自动化的生成API接口文档,完成了一个项目开发及文档输出流程的简要分析,实战掌握更多的工具使用方法

2.9K20

如何使用Sphinx记录Python代码【Programming(Python)】

文档是开发过程的最佳组成部分。 Sphinx与Tox一起,使得它易于编写,易于欣赏。 image.png Python代码可以在其源代码包含文档。...因此,您可以向函数添加文档字符串。 最喜欢的文档字符串样式之一是“ Google”样式 。 标记很轻巧,当它位于源代码时很好。...我们有一个文件的文本。应该有人来看看。 使Python文档更漂亮 为了使您的文档看起来更漂亮,您可以利用Sphinx ,它旨在制作漂亮的Python文档。...:将ReStructured Text源与生成的文档打包在一起 为了告诉Sphinx什么以及如何生成,我们docs / conf.py配置一个辅助文件: extensions = [ 'sphinx.ext.autodoc...我们可以从docstrings开始,添加.rst文件,然后添加Sphinx和Tox为用户美化结果。 对于好的文档,您欣赏什么? 你还有其他喜欢的策略? 请在评论中分享它们!

1.1K00

ReadDocs

搭建工具 Sphinx 是一个基于 Python 的文档生成工具,最早只是用来生成 Python 官方文档,随着工具的完善,越来越多的知名的项目也用他来生成文档,甚至完全可以用他来写书。...命令行进入仓库本地目录,输入sphinx-quickstart 这个是项目的配置文件,这里要改动的是项目名,版本,以及语言。其他的默认即可。生成下面目录结构。...进入目录下面的conf.py可以看到我们刚才的配置的内容就是配置这个文件。下面继续修改。...打开Read the Docs,并使用Github注册,导入项目并点击阅读文档即可。...也可以GitHub 里选择仓库,然后依次点击 Setting => Webhooks & Service => Add service => ReadTheDocs,激活这个选项。

1.2K20

4 个 Python 项目管理与构建工具,建议收藏!

之后就可以 make test, make coverage, make docs,make dist 等。其中 make docs 可以生成一个很漂亮的 Web 文档。...要执行哪个命令便用 tox -e build, tox -e docs 等 体验 tox 命令过程,每一步好像都比较慢,应该是创建虚拟机要花些时间。...它不关注文档的生成,代码规范的检查,代码覆盖率都没有。它的项目配置更集中,全部 pyproject.toml 文件,toml 是什么呢?...poetry shell    # 会根据定义 pyproject.toml 文件的依赖创建并使用虚拟环境 3.  ...所以可以想见,poetry 的项目要生成文档或覆盖率都必须用 poetry run ... 命令来支持 sphinx, coverage 或 flake8。

87830

用正确的姿势开源Python项目

不过推荐使用SPHINX,它是用Python写的工具,使用了一种叫做reStructuredText的语法编辑,可以对多个文本文件重编,可以输出成HTML或者PDF等格式。...还有很关键的一点是Sphinx有autodoc和automodule的扩展, 可以从代码中提取出文档,与代码直接进行关联。提供一个例子可以方便的文档和源码中进行跳转。...Read the Docs 持续文档集成 说完写文档就不得不提到Read the Dosc了,这是一个第三方的文档托管平台,使用Django开发,它可以很轻松的和Github上的项目进行集成,每次代码提交的时候会自动进行文档构建...使用之前,我们需要先做一些初始化的操作: 创建.travis.yml文件 我们需要告诉它一些基本的信息: 我们项目使用的语言 项目使用的语言版本 环境的依赖 是否需要sudo权限运行 使用什么命令来安装...这一项配置要注意,如果项目存在依赖,一定要进行安装,还有Travisci提供了多项配置,包括出错重试等,具体配置可以参考官方文档,要特别注意travis_retry等命令的使用,非常容易出现坑。

88630
领券