如何制作一本在线的电子书或 Python 文档供其他人远程访问
制作在线电子书或Python文档供他人远程访问
若你希望创建类似在线文档或电子书,并直接在云端托管,可借助read the doc。此工具开源免费,且能与GitHub的webhook集成,意味着将文档或电子书上传至GitHub后,read the doc即可自动更新展示,操作极为便捷。
接下来演示生成与部署流程。首先确保已安装sphinx,如需了解sphinx操作,可自行搜索。现提供命令演示。
创建目录并进入,使用`sphinx-quickstart`命令生成配置文件。完成后,目录内将生成所需文件。
进入`source`目录,创建Markdown文件(或使用rst格式,习惯使用Markdown)。假设内容如下:想要`sphinx`支持Markdown,则需安装`recommonmark`。
使用`pip3 install recommonmark`安装。接着修改`conf.py`文件。
安装`sphinx_rtd_theme`,执行`pip install sphinx_rtd_theme`。在`conf.py`中,将主题修改为`rtd`。
在`index.rst`中添加文件索引,保存退出。切换至`handsomeb`目录,执行`make html`。
生成`build`目录下的HTML文件,打开`index`查看。
至此,电子书构建完成,可采用两种方式供他人访问:1、自定义服务器上传文件;2、将文档托管至GitHub并与read the doc关联。
若选择托管至GitHub和read the doc关联,首先在GitHub创建仓库。上传文件后,访问`readthedocs.org`注册账号。直接使用GitHub登录或手动导入Git地址,它将自动与项目集成,构建文档。
完成设置后,即可在线访问文档。下次更新文档时,只需在本地更新并推送至GitHub,read the doc会自动更新展示,操作简便。
多重随机标签