Skip to content

Commit

Permalink
first version
Browse files Browse the repository at this point in the history
  • Loading branch information
fasionchan committed Nov 27, 2018
0 parents commit a7d0da3
Show file tree
Hide file tree
Showing 36 changed files with 885 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.DS_Store
1 change: 1 addition & 0 deletions docs/zh_CN/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
72 changes: 72 additions & 0 deletions docs/zh_CN/.misc/install.log
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
Welcome to the Sphinx 1.7.1 quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Selected root path: .

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/n) [n]:

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:

The project name will occur in several places in the built documentation.
> Project name: Docker笔记
> Author name(s): 陈彦霏
> Project release []:

If the documents are to be written in a language other than English,
you can select a language here by its language code. Sphinx will then
translate text that it generates into that language.

For a list of supported codes, see
http://sphinx-doc.org/config.html#confval-language.
> Project language [en]: zh

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst". Only files with this suffix are considered documents.
> Source file suffix [.rst]:

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]:

Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/n) [n]:
Indicate which of the following Sphinx extensions should be enabled:
> autodoc: automatically insert docstrings from modules (y/n) [n]:
> doctest: automatically test code snippets in doctest blocks (y/n) [n]:
> intersphinx: link between Sphinx documentation of different projects (y/n) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/n) [n]:
> coverage: checks for documentation coverage (y/n) [n]:
> imgmath: include math, rendered as PNG or SVG images (y/n) [n]:
> mathjax: include math, rendered in the browser by MathJax (y/n) [n]:
> ifconfig: conditional inclusion of content based on config values (y/n) [n]:
> viewcode: include links to the source code of documented Python objects (y/n) [n]:
> githubpages: create .nojekyll file to publish the document on GitHub pages (y/n) [n]:

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (y/n) [y]:
> Create Windows command file? (y/n) [y]:

Creating file ./conf.py.
Creating file ./index.rst.
Creating file ./Makefile.
Creating file ./make.bat.

Finished: An initial directory structure has been created.

You should now populate your master file ./index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

20 changes: 20 additions & 0 deletions docs/zh_CN/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Docker
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
23 changes: 23 additions & 0 deletions docs/zh_CN/_fragments/next-step-to-wechat-mp.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
.. 下一步关注微信公众号
FileName: next-step-to-wechat-mp.rst
Author: Fasion Chan
Created: 2018-02-01 20:13:35
@contact: fasionchan@gmail.com
@version: $Id$
Description:
Changelog:
订阅更新,获取更多学习资料,请关注我们的 :ref:`wechat-mp` :

.. figure:: /_static/wechat-mp-qrcode.png
:width: 215px

小菜学编程

.. comments
comment something out below
:width: 258px
19 changes: 19 additions & 0 deletions docs/zh_CN/_fragments/wechat-reward.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. 微信打赏
FileName: wechat-reward.rst
Author: Fasion Chan
Created: 2018-02-03 20:16:18
@contact: fasionchan@gmail.com
@version: $Id$
Description:
Changelog:
.. figure:: /_static/wechat-reward-lnp.png
:width: 680px
:alt: 微信打赏

.. comments
comment something out blow
3 changes: 3 additions & 0 deletions docs/zh_CN/_static/css/hide-ad.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.rtd-pro-footer-wrapper.body {
display: none;
}
15 changes: 15 additions & 0 deletions docs/zh_CN/_static/css/search-box.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#searchbox {
margin-bottom: 12px;
}

#searchbox .searchformwrapper {
overflow: hidden;
}

#searchbox .search div {
display: inline-block;
}

div.sphinxsidebar #searchbox input[type="text"] {
width: 120px;
}
Binary file added docs/zh_CN/_static/favicon.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/_static/logo.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/_static/logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/_static/wechat-mp-qrcode.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/_static/wechat-reward-g-concise.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/_static/wechat-reward-g.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/_static/wechat-reward-lnp.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions docs/zh_CN/_templates/baidu_tongji.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<script>
var _hmt = _hmt || [];
(function() {
var hm = document.createElement("script");
hm.src = "https://hm.baidu.com/hm.js?3d7584e34115fda9fc343709c57a7130";
var s = document.getElementsByTagName("script")[0];
s.parentNode.insertBefore(hm, s);
})();
</script>
2 changes: 2 additions & 0 deletions docs/zh_CN/_templates/busuanzi.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<script async src="//dn-lbstatics.qbox.me/busuanzi/2.3/busuanzi.pure.mini.js"></script>
<span id="busuanzi_container_site_pv">本站总访问量<span id="busuanzi_value_site_pv"></span></span>
22 changes: 22 additions & 0 deletions docs/zh_CN/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{% extends "!layout.html" %}

{% block document %}
{{ super() }}
{% endblock %}

{% block content %}
<div style="display: none">
<img src="{{ pathto('_static/' ~ theme_logo, 1) }}" />
</div>
{{ super() }}
{% endblock %}

{% block footer %}
{{ super() }}
{% include 'baidu_tongji.html' %}
{% endblock %}

{#
{% include 'livere.html' %}
{% include 'busuanzi.html' %}
#}
18 changes: 18 additions & 0 deletions docs/zh_CN/_templates/livere.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- 来必力City版安装代码 -->
<div id="lv-container" data-id="city" data-uid="MTAyMC8zNDMxMi8xMDg0OQ==">
<script type="text/javascript">
(function(d, s) {
var j, e = d.getElementsByTagName(s)[0];

if (typeof LivereTower === 'function') { return; }

j = d.createElement(s);
j.src = 'https://cdn-city.livere.com/js/embed.dist.js';
j.async = true;

e.parentNode.insertBefore(j, e);
})(document, 'script');
</script>
<noscript> 为正常使用来必力评论功能请激活JavaScript</noscript>
</div>
<!-- City版安装代码已完成 -->
31 changes: 31 additions & 0 deletions docs/zh_CN/_templates/more.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<h3>更多阅读</h3>
<ul>
{% for link in [
{
"title": "Go语言小册",
"url": "https://golang-book.readthedocs.io/zh_CN/latest/",
},
{
"title": "学习Linux",
"url": "https://learn-linux.readthedocs.io/zh_CN/latest/",
},
{
"title": "Linux网络编程",
"url": "https://linux-network-programming.readthedocs.io/zh_CN/latest/",
},
{
"title": "NodeJs小册",
"url": "https://nodejs-book.readthedocs.io/zh_CN/latest/",
},
{
"title": "OSX操作指南",
"url": "https://osx-guide.readthedocs.io/zh_CN/latest/",
},
{
"title": "Python语言小册",
"url": "https://python-book.readthedocs.io/zh_CN/latest/",
},
] %}
<li class="toctree-l1"><a class="reference internal" href="{{ link.url }}">{{ link.title }}</a ></li>
{% endfor %}
</ul>
2 changes: 2 additions & 0 deletions docs/zh_CN/_templates/reward.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<h3>微信打赏</h3>
<img src="/_static/wechat-reward-g.png" />
1 change: 1 addition & 0 deletions docs/zh_CN/_templates/sf-namecard-fasionchan.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<script src='//w.segmentfault.com/card/1030000009825671.js?w=0&3rd=1&bg=0&bd=DDDDDD&cl=333333&btn=009a61&noBtn=0'></script>
2 changes: 2 additions & 0 deletions docs/zh_CN/_templates/wechat-mp-qrcode.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<h3>微信公众号</h3>
<img src="{{ pathto('_static/wechat-mp-qrcode.png', 1) }}" />
62 changes: 62 additions & 0 deletions docs/zh_CN/about/contact.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
.. 交流
FileName: contact.rst
Author: Fasion Chan
Created: 2018-03-03 20:09:58
@contact: fasionchan@gmail.com
@version: $Id$
Description:
Changelog:
====
交流
====

GitHub
======

本项目所有示例代码托管在 ``GitHub`` 上,仓库是:
`docker-note <https://github.com/fasionchan/docker-note/>`_ 。

建议初学者亲自动手,将所有示例程序编写一遍,加深理解。
**编程没有捷径** ,唯有带着 **好奇心** 探索程序背后的秘密,多动手勤练习,方能编写出你的理想世界。

如需与我们交流,也可以在在本项目中 `新建一个Issue <https://github.com/fasionchan/docker-note/issues>`_ ,
以这种形式进行讨论。
内容可以包括但不局限于:

- ``BUG`` 反馈
- 建议
- 提问

点击左边 ``Star`` 按钮,关注本项目。
对于后续任何更新,尽在掌握!

.. _wechat-mp:

微信公众号
==========

.. figure:: /_static/wechat-mp-qrcode.png
:align: center

*小菜学编程*

我们维护了一个微信公众号—— **小菜学编程** ,欢迎扫二维码关注我们。

对于后续更新,我们会以公众号文章的形式进行推送,这是订阅我们内容的最佳渠道。
也欢迎通过公众号给我们留言,同样可以包括但不局限于:

- ``BUG`` 反馈
- 建议
- 提问

邮件
====

当然了,更书面的形式也支持,你可以给我们:`发送邮件 <mailto:fasionchan@gmail.com>`_ 。

.. comments
comment something out blow
24 changes: 24 additions & 0 deletions docs/zh_CN/about/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.. 关于
FileName: index.rst
Author: Fasion Chan
Created: 2018-03-03 20:08:14
@contact: fasionchan@gmail.com
@version: $Id$
Description:
Changelog:
====
关于
====

.. toctree::
:maxdepth: 2

交流 <contact>

.. comments
comment something out blow
内推 <recommendation>
27 changes: 27 additions & 0 deletions docs/zh_CN/appendices/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. 附录
FileName: index.rst
Author: Fasion Chan
Created: 2018-03-26 17:25:39
@contact: fasionchan@gmail.com
@version: $Id$
Description:
Changelog:
====
附录
====

.. toctree::
:maxdepth: 3

词汇对照表 <word-list>

.. comments
comment something out below
.. meta::
:description lang=zh:
:keywords:

0 comments on commit a7d0da3

Please sign in to comment.