Read the Docs 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
Read the Docs 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
Read the Docs 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 Python JavaScript
操作系统 跨平台
软件类型 开源软件
开源组织
地区 不详
投 递 者 叶秀兰
适用人群 未知
收录时间 2015-12-11

软件简介

Read the Docs 可以创建、托管和浏览文档,让文档可以被全文搜索和更易查找。您可以导入您使用任何常用的版本控制系统管理的文档,包括 Mercurial、Git、Subversion 和 Bazaar。 我们支持 webhooks,因此可以在您提交代码时自动构建文档。并且同样也支持版本功能,因此您可以构建来自您代码仓库中某个标签或分支的文档。

展开阅读全文

代码

评论 (1)

加载中
打分: 力荐
给力
2018/06/15 10:42
回复
举报
更多评论
暂无内容
发表了博客
2019/12/11 20:50

使用ReadtheDocs托管技术文档

ReadtheDocs Read the Docs非常适合写软件文档以及编写一些教程、电子书之类。对于一些一两篇文章就能写清楚的可以记笔记或写博客, 但是如果要写成一个系列的,不如写成一本书的形式,更美观,也更系统。 Read the Docs是一个在线文档托管系统, 你可以从各种版本控制系统中导入文档,如果你使用webhooks, 那么每次提交代码后可以自动构建并上传至readthedocs网站,非常方便。 现有的写电子书的方式,有以下几个解决方案,优劣...

0
0
发表了博客
2019/06/12 10:55

使用readthedocs 发布 sphinx doc文档

readthedocs 是由社区驱动的开源sphinx doc 托管服务,我们可以用来方便的构建以及发布文档 这是一个简单的demo 项目,使用了用的比较多的sphinx_rtd_theme 主题,主要是试用 注册账户 sphinx 文档需要让readthedocs 托管,我们需要一个账户,注册地址 https://readthedocs.org/ ,注册很简单,我们同时需要进行邮件验证 简单demo 项目 我们可以使用sphinx-quickstart 帮助我们生成简单的测试doc sphinx-quickstart 命令执行之后...

0
1
发表了博客
2020/04/14 14:19

readthedocs网托管持多语言文档

希望在readthedocs上创建支持多语言的文档,效果类似: 通过语言选项,可以切到到不同的语言版本;实现这个目标包含两个主要步骤: 在本地对文档进行翻译 在readthedocs.org上配置翻译 本文假设您已经对sphinx文档生成工具和readthedocs.org文档托管网站有所了解,本文主要专注于多语言的配置上。 在本地对文档进行翻译 翻译之前需要安装一些软件包: sphinx: 文档生成工具 sphinx_intl: 多语言工具 recommonmark: sphinx支持m...

0
1
发表了博客
2020/04/19 07:32

Sphinx + GitHub + ReadtheDocs 创建电子书

Read the Docs是一个在线文档托管服务, 你可以从各种版本控制系统中导入文档。一般来讲,这个非常适合写软件文档以及编写一些教程、电子书之类。 Sphinx Sphinx 是一个基于 Python 的文档生成项目,最早只是用来生成 Python 官方文档,随着工具的完善, 越来越多的知名的项目也用他来生成文档,甚至完全可以用他来写书采用了 reStructuredText 作为文档写作语言, 不过也可以通过模块支持其他格式。 安装Sphinx pip install sp...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
暂无内容
1 评论
12 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部