用ReadtheDocs构建软件技术文档

最新推荐文章于 2024-03-22 14:33:39 发布

就是个linux工程师

最新推荐文章于 2024-03-22 14:33:39 发布

阅读量268

点赞数

分类专栏：嵌入式开发文章标签： linux python

本文链接：https://blog.csdn.net/yanceylu/article/details/113659025

版权

嵌入式开发专栏收录该内容

19 篇文章 7 订阅

订阅专栏

ReadtheDocs

像Linux、U-boot等开源软件，都在使用ReadtheDocs构建专业的软件技术文档。ReadtheDocs提供文档的自动化编译，版本管理以及托管服务。

之前自己在ubuntu里尝试构建了一下，现在回忆一下步骤。

Ubuntu安装包

以root权限安装相关的包。

apt install npm
npm install pip3 (或者apt install python3-pip)
pip3 install sphinx
pip3 install sphinx_rtd_theme

安装完上面这些包，应该创建文档了。在文档目录docs下执行下面命令。

sphinx-quickstart

编译html

make html

另外记得在编译TF-A的docs时，还需要安装下面的包。

pip3 install sphinxcontrib-plantuml
apt install plantuml

确定要放弃本次机会？

福利倒计时

: :

立减 ¥

普通VIP年卡可用

立即使用

就是个linux工程师

关注关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

专栏目录

readthedocs:ReadTheDocs文档，用于项目研究和培训

05-19

ReadTheDocs（RTD）该仓库是GenoPhenoEnvo项目正在使用的“。这些文档的目标文档的目的应该是提供基本的学习材料，以帮助研究人员，教育者和学生有效地（重新）在CyVerse网络基础设施中使用我们的研究材料。所有文档均被视为正在进行中；即使是最大的努力也将是不完整的，包含歧义，不准确的地方，有时甚至会过时。维护的部分我们维护以下模板。中的所有文档均应来自这些文档。它们可以稍作修改，但是文档应努力保持格式一致。 - URL: https://github.com/genophenoenvo/readthedocs 研究：对研究的具体说明以及如何复制它数据源：有关我们在项目中使用的数据集的信息文档：说明数据集的位置以及如何（重新）创建我们的工作流。教程：指导如何使用我们的平台的教程。出版物：：有关该奖项的介绍和经过同行评审的工作。在我们

使用ReadTheDocs构建托管技术文档

06-16

1. **ReadTheDocs**: ReadTheDocs 是一个免费的开源平台，专门用于托管和构建技术文档。它支持多种文档格式，如 Sphinx、Markdown 等，并能自动更新和发布新版本。通过ReadTheDocs，开发者可以轻松地为项目创建专业...

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

Read the Docs 从懵逼到入门

程序员「阿基米东」的编程之旅

10-11

9215

继《GitBook 从懵逼到入门》，时隔两年，终于推出姐妹篇《Read the Docs 从懵逼到入门》。从阅读量来看，笔者已经感受到大家对 GitBook 和 Markdown 写作的关注度，所以决定再给大家介绍一种常见的文档管理方案 —— Sphinx + GitHub + Read the Docs 的文档管理方法。简单来说，就是先用 Sphinx 生成文档，然后用 GitHub 托管文档，再导入到 Read the Docs 生成在线文档。无论是管理技术文档、写书、写笔记，亦或想搭建一个属于你的

Readthedocs

04-29

http://readthedocs.org/docs/translations/en/latest/index.html 转载于:https://www.cnblogs.com/juven/archive/2012/04/29/2476373.html

十分钟拥有你的私人博客！使用readthedocs和mkdocs完成你的文档托管。

Yeg1031的博客

12-27

1306

若是想要拥有一个私人博客或是在网络上共享一份技术文档，我非常推荐使用这个方案，其优点有步骤简单、门槛低，在了解具体做法后甚至还不需要十分钟即可完成整体框架的构建。

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

sjx1989的专栏

12-31

2247

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

readthedocs:尝试在 readthedocs 中发布文档

07-14

Read the Docs（Read the Docs，简称Readthedocs）是一个非常流行的在线平台，它允许开发者托管、构建和发布技术文档。这个平台简化了项目的文档管理，使得用户可以方便地查阅和更新文档。下面我们将深入探讨如何在...

gitbook2readthedocs:从gitbook转换为readthedocs格式

05-05

而ReadTheDocs则是一个基于Web的服务，专注于托管和构建技术文档，它支持多种文档格式，包括Sphinx、mkdocs等，适合用于开源项目或技术文档的发布。 GitBook与ReadTheDocs在结构和展现方式上有所不同。GitBook侧重...

docs:[开源]项目，服务等文档，Sphinx + reStructuredText + ReadTheDocs

03-22

【标题】中的“[开源]项目，服务等文档，Sphinx + reStructuredText + ReadTheDocs”揭示了这个文档工程是基于开源的方式构建的，主要使用了三个关键工具：Sphinx、reStructuredText以及ReadTheDocs。这三者都是...

readthedocs.org：支持readthedocs.org的源代码

02-05

readthedocs.org是一个开源平台，专门用于构建、托管和发布技术文档。这个平台深受Python开发者喜爱，因为它与Sphinx和MkDocs等文档生成工具完美集成，使得编写和展示项目文档变得简单。在这个名为"readthedocs.org-...

Sphinx+vscode+github+readthedocs环境搭建1

08-08

登录账户是amovlab2019密码是***********登录之后可以看到有四个项目，我们与GitHub相关联的是第一个Amov-wiki进入之后点击编译，等

使用ReadtheDocs托管文档

发呆的比目鱼的博客

06-05

2528

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

Sphinx + Readthedocs 避坑速通指南

最新发布

hello！

03-22

1160

博主在学习使用和的过程中，碰到了许多奇葩的 bug, 使得很简单的任务花费了很长的时间才解决，现在在这里做一个分享，帮助大家用更少的时间高效上线文档的内容。Sphinx。

ReadtheDocs托管文档以及常见问题

wangscaler的博客

07-21

1592

使用ReadtheDocs托管文档文章目录使用ReadtheDocs托管文档一、安装Python1、搜索python2、安装3、验证二、安装Sphinx1、安装Sphinx2.初始化三、支持markdown编写1、编写文件2、执行文件3、预览效果四、遇到的问题1.图片不显示2.表格不显示更多学习资源，请关注微信公众号码农Share 一、安装Python 1、搜索python 2、安装 Add python 3.8 to PATH 自动给环境变量添加python的路径表示成功 3、验证

基于Read the Docs的离线文档服务器搭建

weixin_37326222的博客

04-07

3181

1 需求来源在离线的网络环境中开发，难免会遇到查询文档的时候。为了避免在离线和有线的网络环境中频繁切换，决定在局域网搭建Read the Docs。以下是搭建过程中的记录。 2 方案 Docker + Sphinx + Read the Docs 注：以下为只是为了从docker基础镜像开始熟悉流程。实际上可以直接使用docker hub中的镜像 docker pull readthedocs/build:latest 3 开始搭建 3.1 获取centos docker镜像这里我选择了centos7

readthedocs、github 、sphinx

younghz

06-13

6458

查资料啊，查资料。

搭建在线电子书：Sphinx + Github + ReadTheDocs

测试开发小记

11-09

2517

我写博客的初衷是为了系统的构建自己的知识体系，目前使用的平台有微信公众号，CSDN，博客园，GitHub Pages和Gitee Pages，他们都各有优缺点，整理的笔记多了之后发现这些平台不是很方便，比如公众号，CSDN和博客园，每次写完文章后，还需要再平台上进行编辑再发布，比较麻烦；GitHub Pages和Gitee Pages虽然可以快速发布，但是在文章系统管理上不是很方便。我希望将笔记整理成类似电子书一样，方便搜索和管理，经过查询资料，发现了ReadTheDocs这个文档管理工具，比较符合我的需求

在Github里集成Readthedocs服务

weixin_30472035的博客

08-15

264

Readthedocs支持Markdown格式和sphinx格式的文档排版，是部署项目文档的绝佳平台。利用Github的托管服务，我们可以方便地将文档托管于Github，并利用Readthedocs查阅。 1. 在Readthedocs上新建一个项目，在项目中的：管理 -> Integrations -> 添加Github incoming webhook，记下webho...

什么是readthedocs

04-19

Readthedocs是一个托管在线文档的平台，允许开发者将其文档托管到一个在线文档主页，并通过一个简单的URL链接或其他工具将其分发和共享。该平台也提供了自动构建功能，可以使开发者的文档保持最新状态。