-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
lihanghang
committed
Jul 29, 2022
1 parent
7a4cf93
commit d18477a
Showing
9 changed files
with
58 additions
and
2 deletions.
There are no files selected for viewing
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
基于ReadtheDocs托管在线知识库的步骤 | ||
============================================= | ||
.. note:: | ||
更新日期:2022-08-01 | ||
|
||
|
||
Abuout Hang's Tec Room | ||
---------------------------- | ||
本文主要为想使用ReadtheDocs构建在线知识库的小伙伴提供一个参考步骤,我在用这个工具之前尝试了比较多的网站来记录一些笔记,但是感觉还是不到位, | ||
Hang's Tec Room 是基于目前的工具构建的,用起来虽然有些门槛,但只要多练习下就能很快掌握。具体有以下特点: | ||
|
||
1. 工具:Sphinx | ||
2. 托管地址:ReadtheDocs | ||
3. 支持rst和md格式的文档,md还是很常用,编写起来也容易。 | ||
4. 基于github或gitlab进行代码管理,推送后ReadtheDocs自动进行构建和发布。 | ||
5. 支持导出PDF,排版易阅读。 | ||
|
||
|
||
基本实践步骤 | ||
---------------- | ||
.. note:: | ||
做一个基本的操作步骤说明,希望对大家有帮助。 | ||
|
||
1. 新建目录,这里为:my_books并进入目录 | ||
> $ mkdir my_books | ||
> $ cd my_books | ||
2. 安装工具 Sphinx | ||
> pip install -i https://pypi.tuna.tsinghua.edu.cn/simple sphinx | ||
3. 使用Sphinx初始化文档目录 | ||
|
||
> sphinx-quickstart | ||
|
||
.. image:: images/sphinx-start.jpg | ||
|
||
> ls 初始化后的内容 | ||
- Makefile | ||
- build | ||
- make.bat source | ||
|
||
|
||
|
||
-------------- | ||
|
||
- 更多了解\ `Mason`_ | ||
- E-mail: hanghangli@aliyun.com | ||
|
||
.. _Mason: https://lihanghang.top/ |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,4 +3,5 @@ | |
:numbered: 2 | ||
|
||
about_me | ||
about_blog | ||
about_blog | ||
build_readthedocs |