如何制作一本在线的电子书或 Python 文档供其他人远程访问
off999 2024-11-25 15:52 36 浏览 0 评论
可能你有时候会看到这样的文档和在线电子书：
如果你自己想要写一个类似这样的电子书或者文档，并且直接托管到线上，应该怎么操作呢？
这时候我们可以使用 read the doc，它开源免费，并且可以使用到 Github 的 webhook， 也就是说，当你将你的生成的文档或者电子书托管到 GitHub 之后，就可以和 read the doc 进行关联，这样当你每次更新 push 到 GitHub ，read the doc 显示你的在线文档也会跟着一起更新渲染，简直太方便了。
接下来我给你演示一下，如何生成和部署。
首先确保你安装了 sphinx ，如果不知道 sphinx 如何操作可以自行搜索一番，我这里就直接用命令来进行演示了。
首先创建一个目录并进入：
使用 sphinx-quickstart 命令，创建必要的配置文件：
完事之后你的目录下就生成了这么些文件：
进入 source ，创建一个 md 文件（你用 rst 也可以，只不过我习惯用 markdown ）：
假设你的内容如下：
想要 sphinx 支持 markdown ，需要安装 recommonmark
pip3 install recommonmark:
接着修改下 conf.py:
接着我们再安装 rtd 主题
pip install sphinx_rtd_theme：
修改 conf.py， 将 theme 修改为 rtd：
接着在 index.rst 中添加文件索引：
保存退出，到 handsomeb 目录中 make html：
完事之后你的 build 目录下就生成了 html 文件了，打开 index 看看：
这样一本电子书就完成了，现在有两种方式供别人访问：
1、自己扔到自己的服务器上
2、托管到 Github 和 read the doc 关联。
第一种方式太简单了，上传文件到 webserver 即可，就不多说了，我们来看看如何托管到 Github 和 read the doc 关联。
首先在你的 Github 创建一个仓库：
然后把文件 push 上去：
可以看到你的 GitHub 仓库有你刚刚 build 的文件了：
完事之后，进入这个网站注册一个账户：
https://readthedocs.org/
你可以直接使用 GitHub 登录，然后 import 项目：
也可以手动导入，把你刚刚的的 Git 地址填进去：
然后它就会开始去 hook 你的项目，构建文档：
接着就可以让大家在线访问了：
下次你要更新你的文档，只需要直接在本地更新完 push 到 Github 上面去可以了，是不是很 nice 咧？
ok，点击阅读原文可观看更多帅b的骚操作，我们下回见，peace！
- 上一篇：python绑定或无绑定类方法
- 下一篇：Python XOR异或 操作
相关推荐
- 安全教育登录入口平台（安全教育登录入口平台官网）
-
122交通安全教育怎么登录:122交通网的注册方法是首先登录网址http://www.122.cn/，接着打开网页后，点击右上角的“个人登录”；其次进入邮箱注册，然后进入到注册页面，输入相关信息即可完...
- 大鱼吃小鱼经典版（大鱼吃小鱼经典版(经典版)官方版）
-
大鱼吃小鱼小鱼吃虾是于谦跟郭麒麟的《我的棒儿呢？》郭德纲说于思洋郭麒麟作诗的相声，最后郭麒麟做了一首，师傅躺在师母身上大鱼吃小鱼小鱼吃虾虾吃水水落石出师傅压师娘师娘压床床压地地动山摇。...
-
- 哪个软件可以免费pdf转ppt（免费的pdf转ppt软件哪个好）
-
要想将ppt免费转换为pdf的话，我们建议大家可以下一个那个wps，如果你是会员的话，可以注册为会员，这样的话，在wps里面的话，就可以免费将ppt呢转换为pdfpdf之后呢，我们就可以直接使用，不需要去直接不需要去另外保存，为什么格式转...
-
2026-02-04 09:03 off999
- 电信宽带测速官网入口（电信宽带测速官网入口app）
-
这个网站看看http://www.swok.cn/pcindex.jsp1.登录中国电信网上营业厅，宽带光纤，贴心服务，宽带测速2.下载第三方软件，如360等。进行在线测速进行宽带测速时，尽...
- 植物大战僵尸95版手机下载（植物大战僵尸95 版下载）
-
1可以在应用商店或者游戏平台上下载植物大战僵尸95版手机游戏。2下载教程：打开应用商店或者游戏平台，搜索“植物大战僵尸95版”，找到游戏后点击下载按钮，等待下载完成即可安装并开始游戏。3注意：确...
- 免费下载ppt成品的网站（ppt成品免费下载的网站有哪些）
-
1、Chuangkit（chuangkit.com）直达地址：chuangkit.com2、Woodo幻灯片（woodo.cn）直达链接：woodo.cn3、OfficePlus（officeplu...
- 2025世界杯赛程表（2025世界杯在哪个国家）
-
2022年卡塔尔世界杯赛程公布，全部比赛在卡塔尔境内8座球场举行，2022年，决赛阶段球队全部确定。揭幕战于当地时间11月20日19时进行，由东道主卡塔尔对阵厄瓜多尔，决赛于当地时间12月18日...
- 下载搜狐视频电视剧（搜狐电视剧下载安装）
-
搜狐视频APP下载好的视频想要导出到手机相册里方法如下1、打开手机搜狐视频软件，进入搜狐视频后我们点击右上角的“查找”，找到自已喜欢的视频。2、在“浏览器页面搜索”窗口中，输入要下载的视频的名称，然后...
- 永久免费听歌网站（丫丫音乐网）
-
可以到《我爱音乐网》《好听音乐网》《一听音乐网》《YYMP3音乐网》还可以到《九天音乐网》永久免费听歌软件有酷狗音乐和天猫精灵，以前要跳舞经常要下载舞曲，我从QQ上找不到舞曲下载就从酷狗音乐上找，大多...
- 音乐格式转换mp3软件（音乐格式转换器免费版）
-
有两种方法：方法一在手机上操作：1、进入手机中的文件管理。2、在其中选择“音乐”，将显示出手机中的全部音乐。3、点击“全选”，选中所有音乐文件。4、点击屏幕右下方的省略号图标，在弹出菜单中选择“...
- 电子书txt下载（免费的最全的小说阅读器）
-
1.Z-library里面收录了近千万本电子书籍，需求量大。2.苦瓜书盘没有广告，不需要账号注册，使用起来非常简单，直接搜索预览下载即可。3.鸠摩搜书整体风格简洁清晰，书籍资源丰富。4.亚马逊图书书籍...
- 最好免费观看高清电影（播放免费的最好看的电影）
-
在目前的网上选择中，IMDb（互联网电影数据库）被认为是最全的电影网站之一。这个网站提供了各种类型的电影和电视节目的海量信息，包括剧情介绍、演员表、评价、评论等。其还提供了有关电影制作背后的详细信息，...
- 孤单枪手2简体中文版（孤单枪手2简体中文版官方下载）
-
要将《孤胆枪手2》游戏的征兵秘籍切换为中文，您可以按照以下步骤进行操作：首先，打开游戏设置选项，通常可以在游戏主菜单或游戏内部找到。然后，寻找语言选项或界面选项，点击进入。在语言选项中，选择中文作为游...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)