Readthedocs + Gitee 搭建文档

最新推荐文章于 2025-07-04 02:07:31 发布

原创最新推荐文章于 2025-07-04 02:07:31 发布 · 147 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#html #vue #git #java #react

本文详细介绍了使用Sphinx工具进行文档构建的过程，包括环境部署、文档撰写、预览及发布等关键步骤。通过实例演示了如何将文档上传至ReadtheDocs平台，并提供了注意事项避免常见错误。

一、文档撰写前提

环境部署:

# git clone https://gitee.com/zhyantao/readthedocs.git
# pip install sphinx recommonmark sphinx-autobuild sphinx_rtd_theme -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirrors.aliyun.com

二、撰写博文并发表

把你要发表的博文放在 demo-readthedocs/source/docs 文件夹中
CMD中输入 make html 回车，打开 build/html/index.html 预览效果
提交代码(博文)到 Gitee 仓库 [git简易指南]
在 Read the Docs中导入 Gitee 项目
导入成功后，点击 View the documentation 查看最终效果 [示例]

Warning

除了 demo-readthedocs/source/docs 下的文件和 source/index.rst 可以修改外，其他位置的文件不要修改，否则可能会引起错误。另外，务必在 source/index.rst 文件中添加刚编辑过的博文路径

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

「已注销」

关注关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
分享

复制链接

分享到 QQ

分享到新浪微博

扫一扫
举报

举报

【第6节】Lagent & AgentLego 智能体应用搭建

熊猫小妖的AI世界

04-24

1467

在这一部分中，我们将带大家直接使用 AgentLego 工具，体验 AgentLego 的 WebUI，以及基于 AgentLego 自定义工具并体验自定义工具的效果。在上面介绍中可知，AgentLego 算法库既可以直接使用，也可以作为智能体工具使用。下面将分别介绍这两种使用方式。我们将以目标检测工具为例。

搭建FISCO BCOS区块链平台

易龙杨Longyang Yi的博客

03-17

2086

这是为北京交通大学《区块链技术》课程准备的实验教程，因面向全校研究生开放课程，故准备了详细的步骤。本文是实验第一步，用于搭建FISCO BCOS区块链平台。

参与评论您还未登录，请先登录后发表或查看评论

readthedocs 与 gitee 集成 webhooks

icbm的专栏

07-28

1196

在 gitee 上托管 readthedocs 上文档的源代码。当源代码更新后，通过 webhooks 通知 readthedocs 重新构建文档，使文档始终保持更新。

Sphnix+git+ReadTheDocs写wiki实践笔记记录——ReadTheDocs基本更新

01-06

reStructuredText文档更新文档更新后，必须用sphnix制作新html，因为read the docs只加载html内容。 1. 用编辑器打开需要修改的rst文件，之后保存 2. 进入WIKI的目录下（与make.bat在一级），输入make html 加载完毕后，html即更新。如果出现以下问题： The 'sphinx-build' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the

python Sphinx + gitee + ReadtheDocs

人生苦短，何妨一试

03-27

1558

Sphinx 安装 pip install -i https://pypi.tuna.tsinghua.edu.cn/simple sphinx 创建demo sphinx-quickstart 普通编译 .\make html 安装autobuild工具 pip install -i https://pypi.tuna.tsinghua.edu.cn/simple sphinx-autobuild 启动http服务 sphinx-autobuild source b...

Sphinx+Gitee+ReadtheDocs搭建在线阅读文档系统

网优如梦

08-21

448

Sphinx+Gitee+ReadtheDocs搭建在线阅读文档系统

使用 gitee+sphinx+readthedocs 搭建个人博客

朱雀随云记的博客

01-11

1497

gitee，是国内免费的代码托管平台，相比github在国内，有更快的访问速度，全中文界面，对国人，更友好。sphinx，是一个功能强大的文档生成器，具有许多用于编写技术文档的强大功能。readthedocs，是一个免费在线文档托管范围平台，可以使用二级域名显示个人博客。

Readthedocs+Github搭建文档

天道酬勤

02-24

2598

一、文档撰写前提环境部署: git clone https://gitee.com/zhyantao/readthedocs.git pip install sphinx recommonmark sphinx-autobuild sphinx_rtd_theme -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirror...

【CentOS-7.4】Sphinx + ReadTheDocs

qu6zhi

02-06

789

【CentOS-7.4】Sphinx + ReadTheDocs 【目标】在不使用自己的服务器的情况下，将文章通过 Github 等代码托管平台，发布到ReadTheDocs 文档托管平台上。 ReadTheDocs 文档托管的平台，能够和常用的 GIT 阵营的 github，HG 阵营的 Bitbucket。 Github 代码托管 Sphinx 文档书写利器...

使用ReadTheDocs构建托管技术文档

06-16

使用readthedocs+github(gitee)+sphinx+reST+typora+webhooks，自动构建托管文档。

使用readthedocs+github+sphinx+reST构建文档

hello world

09-24

386

安装pip install --user sphinx sphinx-autobuild sphinx_rtd_theme read the docs sphinx使用手册参考：如何用 ReadtheDocs、Sphinx 快速搭建写书环境

Read the Docs 项目文档添加指南：从零开始部署技术文档

gitblog_00091的博客

06-05

379

作为技术文档托管平台，Read the Docs 为开发者提供了便捷的文档托管和构建服务。本文将详细介绍如何在 Read the Docs 平台上添加新的文档项目，帮助开发者快速搭建专业的技术文档站点。 ## 准备工作在开始添加项目前，请确保已完成以下准备： 1. 拥有一个有效的 Read the Docs 账户 2. 文档源代码已托管在支持的代码托管平台上 3. 对目标仓库拥有管理员权限...

从0到1搭建文档库——sphinx + git + read the docs

一个混子&菜鸡的博客

04-07

3256

小结：无法自动翻译，需要根据中文人工手动输入英文内容，然后进行转化（生成一个新的项目）。新项目导入到read the docs（注意设置语言），然后将翻译后的项目配置为原语言项目的子项目，在【翻译】中设置。在项目管理中勾选后，git有更新，read the docs会同步重新构建，构建完成后页面变更【大概几分钟延迟】1）当有版本更新时，原先最新的版本release，tag命名vx.x，在项目-版本中激活vx.x。当v0.3推出时，master分支 release v0.2，项目-版本——激活v0.2。

在线电子书创建：MkDocs + Github + ReadTheDocs

测试开发小记

06-09

1920

MkDocs是一个静态站点生成器，可用于构建项目文档。文档文件使用Markdown语法编写，本文记录如何使用MkDocs生成项目文档，并部署到上。

Sphinx和ReadtheDocs构建一个文档网站

最新发布

m0_62919535的博客

07-04

1149

本文介绍了如何从零开始使用Sphinx工具搭建Python文档系统并部署到ReadTheDocs平台。主要内容包括：1)通过Anaconda创建Python环境并安装Sphinx；2)使用sphinx-quickstart命令初始化项目；3)更换阅读主题为sphinx_rtd_theme；4)添加Markdown支持；5)构建文档目录结构；6)将项目托管到Gitee；7)最终部署到ReadTheDocs平台。整个过程涵盖了环境配置、文档编写、版本控制和在线部署等关键步骤，为Python开发者提供了完整的文档

本地安装 readthedocs的过程及遇到的问题解决

sjx1989的专栏

12-31

2515

我使用的系统是Ubuntu 16.03 server版安装完成后，本地安装readthedocs的步骤： ================================================================ 1 参照官方教程，https://docs.readthedocs.io/en/latest/install.html 2 提前安装下面的部分，这部分教程

批量迁移Gitee仓库到Github

M2kar的专栏

03-13

1083

title: “批量迁移Gitee仓库到Github” date: 2019-12-06 description: “批量迁移Gitee仓库到GitHub” tags: [“Git”,“Github”,“Gitee”,“迁移仓库”] categories: [“运维”] 背景虽然Gitee仓库蓬勃发展，趋势很好，但是客观来讲，和Github的易用性还是有一定差距的。当初由于Github私有...

VScode+Sphinx+ReadTheDocs 从环境搭建到放弃

大葱Blog

12-21

7463

概述此篇博客用来记录在windows10中配置环境的过程，注意是Windows下，我没有在Linux下面尝试过配置。一下参考了各路教程加上自己亲测，应该是没有问题的。 ……..被掏空(◎_◎;)目录概述目录材料清单工具安装 VScode配置 GitHub配置 Read The Docs 配置完成参考资料材料清单 Python 3.4 Visual Studio Code Git Git