杂谈¶
关于类似技术文档的制作方法¶
首先要说一下主要用到的主要技术 sphinx 可以 看这个文档学习 写最好的文档Sphinx+Read the Docs <https://avnpc.com/pages/writing-best-documentation-by-sphinx-github-readthedocs>
常见错误¶
- 在安装sphinx这个包的时候 要注意你自己python的版本 有时候直接pip install不成功是因为版本的问题 或者用可以直接把包下载下来用 python setup的方式来安装
流程¶
- 使用sphinx在本地写好文档并生成成功
- 传到github
- 注册登录Read the Docd 并关联你的github账户
- 之后他就会自动构建你的文档
- 然后就可以分享给你的小伙伴们了
好处¶
这个东西方便就方便在你可以把它看成你个人的博客 虽然比博客确实少了很多的功能 不过单纯的展示和记录的话
首先不需要你自己去买服务器买域名
其次使用github和R_T_D 托管后 有新的更新内容 只需要 git push就可以同步的更新内容
配置https解决方法¶
一般我们是用到nginx服务器来配置https 我来讲一下我所知道的nginx服务器配置方法
首先这是一个非常常见的解决方案 相关的流程阿里云也给出了 我就讲讲按着流程无法解决的点
- 需要的文件无法下载到linux服务器
解决方法 先把文件下载到自己的电脑上 如果是Ubuntu的服务器`apt install lrzsz` 然后在nginx下输入`rz`然后就可以把文件传到服务器上了