我们需要将其托管到Github中,便于后续Read the docs部署。 下面我将以RapidVideOCR为例,讲解具体做法: 克隆RapidVideOCR项目到本地:git clone git@github.com:SWHL/RapidVideOCR.git xxx@xxx MINGW64 /g/ProgramFiles/_self/tmp $ git clone git@github.co
部署到Read the docs网站 目前Sphinx渲染的文件已经托管到Github的docs分支,接下来需要托管到Read the docs网站,便于大家查看和访问。 注册或登录Raad the docs 连接Github服务。 3. 点击导入一个项目按钮 4. 选择RapidVideOCR项目 5. 注意更改默认分支为docs, 点击下一页即可 6. 点击Build version,即可开始构建文档...
1.1 Read the Docs Read the Docs 是一个基于 Sphinx 的免费文档托管项目。该项目在 2010 年由 Eric Holscher、Bobby Grace 和 Charles Leifer 共同发起。2011年3月,Python 软件基金会曾给 Read the Docs 项目资助 840 美元,作为一年的服务器托管费用。此后,受到越来越多开源社区和开发者的关注。 Read the Docs...
至此,简单的定制化已经完毕。接下来就是要在文档中插入内容和部署到Read the docs网站了。
Read the Docs是一个在线文档托管服务, 你可以从各种版本控制系统中导入文档 1 安装环境 Windows系统 python3环境 2 Sphinx安装与测试 2.1 基础功能安装 首先是安装Sphinx,在windows的命令行中输入下面的命令 pip install-i https://pypi.tuna.tsinghua.edu.cn/simple sphinx ...
本文介绍一种在线文档系统的搭建,需要借助Sphinx、gitee和Read the Docs。 Sphinx是一个功能强大的文档生成器,具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统,相比github,有着更快的访问速度 Read the Docs是一个在线文档托管服务, 你可以从各种版本控制系统中导入文档 ...
Read the Docs simplifies technical documentation by automating building, versioning, and hosting for you. Build up-to-date documentation for the web, print, and offline use on every version control push automatically.
本文介绍一种在线文档系统的搭建,需要借助Sphinx、gitee和Read the Docs。 Sphinx是一个功能强大的文档生成器,具有许多用于编写技术文档的强大功能 gitee是一种版本管理系统,相比github,有着更快的访问速度 Read the Docs是一个在线文档托管服务, 你可以从各种版本控制系统中导入文档 ...
确保已使用Sphinx和Read the Docs建立英文版本的在线文档项目,并且该项目已与GitHub仓库关联。安装sphinxintl:在本地环境中安装sphinxintl工具,该工具用于管理Sphinx文档的多语言翻译。配置多语言支持:在Sphinx的配置文件conf.py中设置多语言支持。这通常包括指定主语言、添加翻译语言以及设置翻译文件的路径。
Read the Docs是一个用于托管和发布文档的网站。以下是关于Read the Docs的详细解答:主要功能:Read the Docs允许用户托管和发布由MkDocs等文档工具生成的静态网站。这使得项目文档能够轻松地在互联网上访问和分享。使用流程:主题设计:用户可以通过修改项目中的mkdocs.yml文件来调整文档的主题设计,以满足...