Read the Docs + Sublime Text + Sphinx + Github托管文档

最新推荐文章于 2024-04-07 18:36:19 发布
最新推荐文章于 2024-04-07 18:36:19 发布
阅读量861 收藏 4
点赞数
文章标签： 代码编写
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Spring_24/article/details/101057070
版权

目录：

一、Read the Docs简介

Read the Docs 是一个软件文档托管平台。源代码是开源的，服务也是免费的。它支持使用 reStructuredText 编写的 Sphinx 文档，并且支持 Subversion，Bazaar，Git 和 Mercurial 等。 Sphinx 是一个文档生成工具，最初是为编写 Python 文档创建的，现在它拥有出色的工具，可以用于各种语言编写的软件项目。reStructuredText 是一个易于阅读的纯文本标记语法和解析器系统。reStructuredText 是对 StructuredText 和 Setext 轻量级标记系统的修订和重新解释。

二、Sublim

最低0.47元/天 解锁文章
Spring_24
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
MinGW+Sublime Text3安装包
02-13
MinGW+Sublime Text3安装包，利用MinGW可以实现Sublime Text3对C语言进行编译和运行。
Sublime Text 3 + EditPlus + Nodepad++ 编辑器
05-24
内附: Sublime Text 3 + EditPlus + Nodepad++免安装版，解压即可使用 Win7x64可用,其他可以自行尝试
Read the Docs 从懵逼到入门
yygr的博客
01-11 565
继，时隔两年，终于推出姐妹篇《Read the Docs 从懵逼到入门》。从阅读量来看，笔者已经感受到大家对 GitBook 和 Markdown 写作的关注度，所以决定再给大家介绍一种常见的文档管理方案 ——+ GitHub + Read the Docs 的文档管理方法。无论是管理技术文档、写书、写笔记，亦或想搭建一个属于你的个人知识库，都是一个不错的选择。那我们现在开始吧！
从0到1搭建文档库——sphinx + git + read the docs
一个混子&菜鸡的博客
04-07 1829
小结：无法自动翻译，需要根据中文人工手动输入英文内容，然后进行转化（生成一个新的项目）。新项目导入到read the docs（注意设置语言），然后将翻译后的项目配置为原语言项目的子项目，在【翻译】中设置。在项目管理中勾选后，git有更新，read the docs会同步重新构建，构建完成后页面变更【大概几分钟延迟】1）当有版本更新时，原先最新的版本release，tag命名vx.x，在项目-版本中激活vx.x。当v0.3推出时，master分支 release v0.2，项目-版本——激活v0.2。
Read the Docs 入门
汪心禾的博客
05-06 7579
入门 本文将向您展示如何使用Read the Docs。您可以在5分钟内将您的文档导入Read the Docs，为世界精美展现。 如果您已经为您的文档使用了Sphinx或Markdown，请直接跳到导入您的文档。 写文档 您有两种方式格式化文档： 使用 reStructuredText 使用 Markdown reStructuredText 有一个屏幕录制，如果您愿意...
Github + Sphinx+Read the docs 实战入门指南（一）
有问题请直接说问题就好
03-18 1094
Sphinx入门指南
Read the Docs 文档管理
热门推荐
氢键H-H
09-19 1万+
Sphinx + GitHub + Read the Docs 的文档管理方法
python+sublime text.zip
08-27
python最新版编译环境 python3 windows 64位可执行程序 以及最新版sublime text安装包和汉化插件
Mac版SwitchHosts3.5.4+SublimeText3.zip
04-23
SwitchHosts 是一个host文件管理工具，可以一键变更配置好的host，无需重复修改host文件。 SublimeText是一款很棒的文档编辑器，拥有丰富的编辑功能；高性能处理文本，可以快速打开大文本文件。
sublime-sphinx-completion:由 Sphinx 文档工具为内联语义标记定义的 reStructuredText 解释文本角色的 Sublime Text 完成集合
07-12
Sublime Text Sphinx 完成 这是由文档工具为定义的解释文本角色的 Sublime Text 完成的集合。 这些完成在text.restructuredtext范围内是活动的。 并非所有角色都包括在内； 我只是根据需要添加它们。 非常欢迎添加您的收藏夹的请求！ 安装 将存储库克隆到您的： git clone git@github.com:douglatornell/sublime-sphinx-completion 用 输入角色名称并点击tab 。 角色名称将替换为:role_name:``并且插入点将保留在反引号之间，以便您键入要应用角色的文本。 例子： file<tab>完成为:file:`` 再次点击 Tab 跳过关闭的 backtip。 您可以只使用角色名称的前几个字母； 例如program和prog都完成了:program:`` 。 注：由于显而易见的
html网页制作Notepad++、Sublime Text、VS Code
最新发布
06-15
- 使用文本编辑器（如Notepad++、Sublime Text、VS Code等）创建一个新文件，以 `.html` 为扩展名。 - 在文件中编写 HTML 结构，包括 `<html>`、`<head>` 和 `<body>` 标签。 2. **添加基本元素**： - 在 `...
使用ReadtheDocs托管文档
发呆的比目鱼的博客
06-05 2341
使用 Sphinx 给 Python 项目生成【Read the Docs】在线文档
【小沐学Python】Python实现在线电子书制作（Sphinx + readthedocs + github + Markdown）
爱看书的小沐
06-11 2879
Sphinx 是一个 文档生成器 ，您也可以把它看成一种工具，它可以将一组纯文本源文件转换成各种输出格式，并且自动生成交叉引用、索引等。也就是说，如果您的目录包含一堆 reStructuredText 或 Markdown 文档，那么 Sphinx 就能生成一系列HTML文件，PDF文件（通过LaTeX），手册页等。Sphinx 专注于文档，尤其是 handwritten documentation ，然而，Sphinx 也可以用来生成博客、主页甚至书籍。
搭建在线电子书：Sphinx + Github + ReadTheDocs
测试开发小记
11-09 2408
我写博客的初衷是为了系统的构建自己的知识体系，目前使用的平台有微信公众号，CSDN，博客园，GitHub Pages和Gitee Pages，他们都各有优缺点，整理的笔记多了之后发现这些平台不是很方便，比如公众号，CSDN和博客园，每次写完文章后，还需要再平台上进行编辑再发布，比较麻烦；GitHub Pages和Gitee Pages虽然可以快速发布，但是在文章系统管理上不是很方便。我希望将笔记整理成类似电子书一样，方便搜索和管理，经过查询资料，发现了ReadTheDocs这个文档管理工具，比较符合我的需求
基于Read the Docs的离线文档服务器搭建
weixin_37326222的博客
04-07 3006
1 需求来源 在离线的网络环境中开发，难免会遇到查询文档的时候。为了避免在离线和有线的网络环境中频繁切换，决定在局域网搭建Read the Docs。以下是搭建过程中的记录。 2 方案 Docker + Sphinx + Read the Docs 注：以下为只是为了从docker基础镜像开始熟悉流程。实际上可以直接使用docker hub中的镜像 docker pull readthedocs/build:latest 3 开始搭建 3.1 获取centos docker镜像 这里我选择了centos7
推荐开源项目: Read the Docs
gitblog_00006的博客
03-11 302
推荐开源项目: Read the Docs Read the Docs 是一个免费的文档托管平台，旨在帮助开发者轻松地管理和发布他们的软件文档。它支持多种编程语言和技术栈，并且提供了强大的自动化构建和版本控制功能。 什么是 Read the Docs？ Read the Docs 是一款基于 Web 的文档管理系统，可以帮助开发者生成、托管和发布他们的软件文档。只需将源代码和相关文档上传到 Rea...
Ｓｐｈｉｎｘ　生成ＨＴＭＬ格式ＡＰＩ文档
小黑
03-06 535
### [Sphinx](http://www.sphinx-doc.org/en/stable/contents.html) - Install [python](https://www.python.org/downloads/) - Install Sphinx ` python -m pip install -U pip Sphinx   ` - set PATH
sublime+text3运行c++
03-16
Sublime Text 3可以用于编写和运行C++代码。以下是一些步骤： 1. 安装MinGW：在Windows上，你需要安装MinGW来编译和运行C++代码。你可以从MinGW官网下载安装程序并按照指示安装。 2. 安装Sublime Text 3：你可以从...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值