Skip to content

Commit

Permalink
[doc] add readthedocs guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lihanghang committed Jul 29, 2022
1 parent 7a4cf93 commit d18477a
Show file tree
Hide file tree
Showing 9 changed files with 58 additions and 2 deletions.
Binary file modified build/doctrees/environment.pickle
Binary file not shown.
1 change: 1 addition & 0 deletions build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/about_me.html">1. 关于我</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/about_blog.html">2. 关于技术屋</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/build_readthedocs.html">3. 基于ReadtheDocs托管在线知识库的步骤</a></li>
</ul>
<p class="caption"><span class="caption-text">编程语言及开发框架</span></p>
<ul>
Expand Down
6 changes: 6 additions & 0 deletions build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/about_me.html">1. 关于我</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/about_blog.html">2. 关于技术屋</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/build_readthedocs.html">3. 基于ReadtheDocs托管在线知识库的步骤</a></li>
</ul>
<p class="caption"><span class="caption-text">编程语言及开发框架</span></p>
<ul>
Expand Down Expand Up @@ -258,6 +259,11 @@ <h2>目录:<a class="headerlink" href="#id1" title="永久链接至标题">¶</a
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/about_blog.html">2. 关于技术屋</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/build_readthedocs.html">3. 基于ReadtheDocs托管在线知识库的步骤</a><ul>
<li class="toctree-l2"><a class="reference internal" href="doc/关于/build_readthedocs.html#abuout-hang-s-tec-room">3.1. Abuout Hang’s Tec Room</a></li>
<li class="toctree-l2"><a class="reference internal" href="doc/关于/build_readthedocs.html#id1">3.2. 基本实践步骤</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
Expand Down
Binary file modified build/html/objects.inv
Binary file not shown.
1 change: 1 addition & 0 deletions build/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/about_me.html">1. 关于我</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/about_blog.html">2. 关于技术屋</a></li>
<li class="toctree-l1"><a class="reference internal" href="doc/关于/build_readthedocs.html">3. 基于ReadtheDocs托管在线知识库的步骤</a></li>
</ul>
<p class="caption"><span class="caption-text">编程语言及开发框架</span></p>
<ul>
Expand Down
2 changes: 1 addition & 1 deletion build/html/searchindex.js

Large diffs are not rendered by default.

47 changes: 47 additions & 0 deletions source/doc/关于/build_readthedocs.rst
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/
Binary file added source/doc/关于/images/sphinx-start.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion source/doc/关于/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
:numbered: 2

about_me
about_blog
about_blog
build_readthedocs

0 comments on commit d18477a

Please sign in to comment.