add license

LICENSE.md

@@ -0,0 +1,8 @@
+LICENSE
+=======
+
+![知识共享许可协议](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)
+
+本文档采用 [知识共享署名-相同方式共享 4.0 国际许可协议](https://creativecommons.org/licenses/by-sa/4.0/) 进行许可。
+
+本许可协议授权之外的使用权限可以从 https://www.owent.net/about 处获得。

LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 OWenT
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

Makefile

@@ -14,7 +14,17 @@ help:
 
 .PHONY: help Makefile
 
+# COPY_FILES = $(SOURCEDIR)/LICENSE.txt $(SOURCEDIR)/LICENSE.md
+# 
+# all: $(COPY_FILES)
+# 
+# $(SOURCEDIR)/LICENSE.txt: LICENSE.txt
+# $(SOURCEDIR)/LICENSE.md: LICENSE.md
+# 
+# $(SOURCEDIR)/%:
+#     cp -f $< $@
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
+%: Makefile # COPY_FILES
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -0,0 +1,7 @@
+# xresloader-docs
+
+本仓库是转表工具链 [xresloader](https://github.com/xresloader/) 的文档源码，即： https://xresloader.atframe.work 
+
+## LICENSE
+
+See [LICENSE.md](LICENSE.md)

requirements.txt

@@ -1,10 +1,12 @@
 setuptools>=41.2.0
+recommonmark>=0.6.0
 sphinx>=2.2.0
 sphinx-autobuild>=0.7.1
 sphinx-rtd-theme>=0.3.0
 recommonmark>=0.4.0
 sphinx-readable-theme>=1.3.0
 readthedocs-sphinx-ext>=0.5.9
+sphinx-markdown>=1.0.2
 # NOTE: switched to custom branch until https://github.com/dreamhost/sphinxcontrib-fulltoc/issues/10 is fixed
 # sphinxcontrib-fulltoc>=1.2.0
 # git+https://github.com/eli-collins/sphinxcontrib-fulltoc.git

source/LICENSE.rst

@@ -0,0 +1,22 @@
+LICENSE
+=======
+
+LICENSE - 文档
+---------------------------------------------
+
+.. image:: https://i.creativecommons.org/l/by-sa/4.0/88x31.png
+   :alt: 知识共享署名-相同方式共享 4.0 国际许可协议
+   :target: https://creativecommons.org/licenses/by-sa/4.0/
+
+本文档采用 `知识共享署名-相同方式共享 4.0 国际许可协议 <https://creativecommons.org/licenses/by-sa/4.0>`_ 进行许可。
+
+本许可协议授权之外的使用权限可以从 https://www.owent.net/about 处获得。
+
+LICENSE - xresloader
+---------------------------------------------
+
+.. _xresloader: https://github.com/xresloader
+
+`xresloader`_ 采用 The MIT License (MIT)
+
+.. include:: ../LICENSE.txt

source/conf.py

@@ -42,6 +42,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'recommonmark',
     # standard sphinx extensions
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
@@ -67,10 +68,11 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-#source_suffix = ['.rst', '.md']
-#add_source_suffix('.rst', 'restructuredtext')
-#add_source_suffix('.md', 'markdown')
-# source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
 
 #source_parsers = {
 #    '.md': CommonMarkParser,
@@ -121,6 +123,10 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_css_files = ['css/custom.css']
+
+html_js_files = []
+
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
@@ -230,9 +236,9 @@
 
 
 # custom styles
-def setup(app):
-    app.add_stylesheet('css/custom.css')  # may also be an URL
-    app.add_source_suffix('.rst', 'restructuredtext')
-    app.add_source_suffix('.md', 'markdown')
-    app.add_source_parser(CommonMarkParser)
+# def setup(app):
+#     app.add_stylesheet('css/custom.css')  # may also be an URL
+#     app.add_source_suffix('.rst', 'restructuredtext')
+#     app.add_source_suffix('.md', 'markdown')
+#     app.add_source_parser(CommonMarkParser)
 

source/index.rst

@@ -97,6 +97,7 @@ xresloader文档
 .. toctree::
    :caption: 其他
 
+   LICENSE
    about
 
 ..