Add rtds support.

docs/cn/README.md

@@ -1,4 +1,14 @@
-## Ruia 中文文档
+# Ruia Documentation
+
+```eval_rst
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+
+    first_steps/index
+    topics/index
+
+```
 
 **Ruia**是一个基于`asyncio`和`aiohttp`的异步爬虫框架，它的目标是让你更加方便且迅速地编写出属于自己的爬虫
 

docs/cn/first_steps/index.md

@@ -0,0 +1,13 @@
+# First Steps
+
+```eval_rst
+
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+
+    Introduction <introduction.md>
+    Tutorial <tutorials.md>
+    Write a Plugin <plugins.md>
+
+```

docs/cn/topics/index.md

@@ -0,0 +1,10 @@
+# Topics
+
+```eval_rst
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+    :glob:
+
+    *
+```

docs/cn/topics/spider.md

@@ -1,8 +1,8 @@
 ## Spider
 
 `Spider`是爬虫程序的入口，它将Item、Middleware、Request、等模块组合在一起，从而为你构造一个稳健的爬虫程序。你只需要关注以下两个函数：
-- [Spider.start]()：爬虫的启动函数
-- [parse]()：爬虫的第一层解析函数，继承`Spider`的子类必须实现这个函数
+- Spider.start()：爬虫的启动函数
+- parse()：爬虫的第一层解析函数，继承`Spider`的子类必须实现这个函数
 
 ### Core arguments
 

docs/conf.py

@@ -0,0 +1,208 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+import recommonmark.parser
+import recommonmark.transform
+import sphinx_rtd_theme
+
+sys.path.insert(1, os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
+sys.path.insert(1, os.path.dirname(os.path.realpath(__file__)))
+
+# -- Project information -----------------------------------------------------
+
+project = 'ruia'
+copyright = ''
+author = 'howie6879'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = ''
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+needs_sphinx = ''
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    # 'sphinx.ext.doctest',
+    # 'sphinx.ext.intersphinx',
+    # 'sphinx.ext.todo',
+    # 'sphinx.ext.coverage',
+    # 'sphinx.ext.mathjax',
+    # 'sphinx.ext.ifconfig',
+    # 'sphinx.ext.viewcode',
+    # 'sphinx.ext.githubpages',
+]
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ['.rst', '.md']
+source_parsers = {'.md': recommonmark.parser.CommonMarkParser}
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+
+html_theme = "sphinx_rtd_theme"
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ruiadoc'
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'ruia.tex', 'Ruia Documentation',
+     'ruia', 'manual'),
+]
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'Ruia', 'Ruia Documentation',
+     [author], 1)
+]
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Ruia', 'Ruia Documentation',
+     author, 'howie6879',
+     'An async web scraping micro-framework, written with asyncio and aiohttp, '
+     'aims to make crawling url as convenient as possible.',
+     'Miscellaneous'),
+]
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        # 'url_resolver': lambda url: github_doc_root + url,
+        'enable_auto_toc_tree': True,
+        'auto_toc_tree_section': 'Contents',
+        'enable_math': True,
+        'enable_inline_math': True,
+        'enable_eval_rst': True,
+    }, True)
+    app.add_transform(recommonmark.transform.AutoStructify)

docs/en/APIs/field.md

@@ -0,0 +1,7 @@
+# Field
+
+```eval_rst
+.. automodule:: ruia.field
+    :members:
+    :show-inheritance:
+```

docs/en/APIs/index.md

@@ -0,0 +1,10 @@
+# APIs
+
+```eval_rst
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+    :glob:
+
+    *
+```

docs/en/APIs/item.md

@@ -0,0 +1,7 @@
+# Item
+
+```eval_rst
+.. automodule:: ruia.item
+    :members:
+    :show-inheritance:
+```

docs/en/APIs/middleware.md

@@ -0,0 +1,7 @@
+# MiddleWare
+
+```eval_rst
+.. automodule:: ruia.middleware
+    :members:
+    :show-inheritance:
+```

docs/en/APIs/request.md

@@ -0,0 +1,7 @@
+# Request
+
+```eval_rst
+.. automodule:: ruia.request
+    :members:
+    :show-inheritance:
+```

docs/en/APIs/response.md

@@ -0,0 +1,7 @@
+# Response
+
+```eval_rst
+.. automodule:: ruia.response
+    :members:
+    :show-inheritance:
+```

docs/en/APIs/settings.md

@@ -0,0 +1,7 @@
+# Settings
+
+```eval_rst
+.. automodule:: ruia.settings
+    :members:
+    :show-inheritance:
+```

docs/en/APIs/spider.md

@@ -0,0 +1,7 @@
+# Spider
+
+```eval_rst
+.. automodule:: ruia.spider
+    :members:
+    :show-inheritance:
+```

docs/en/APIs/wrappers.md

@@ -0,0 +1,7 @@
+# Wrappers
+
+```eval_rst
+.. automodule:: ruia.wrappers
+    :members:
+    :show-inheritance:
+```

docs/en/README.md

@@ -1,13 +1,23 @@
 ## Ruia documentation
 
-**ruia** is an asynchronous crawler framework, based on `asyncio` and `aiohttp`. *Write less, run faster* is ruia's philosophy.
 
+```eval_rst
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+
+    First Step <first_step/index.md>
+    Topics <topics/index.md>
+    APIs <APIs/index.md>
+```
+
+**ruia** is an asynchronous crawler framework, based on `asyncio` and `aiohttp`. *Write less, run faster* is ruia's philosophy.
 
 ### First steps
 
-- [Introduction](./first_steps/introduction.md)：Introducing Ruia
-- [Tutorials](./first_steps/tutorials.md)：Ruia Tutorial 
-- [Plugins](./first_steps/plugins.md)：Ruia Plugin
+- [Introduction](first_step/introduction.md)：Introducing Ruia
+- [Tutorials](first_step/tutorials.md)：Ruia Tutorial 
+- [Plugins](first_step/plugins.md)：Ruia Plugin
 
 ### Topics
 

docs/en/first_step/index.md

@@ -0,0 +1,13 @@
+# First Steps
+
+```eval_rst
+
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+
+    Introduction <introduction.md>
+    Tutorial <tutorials.md>
+    Write a Plugin <plugins.md>
+
+```

docs/en/topics/index.md

@@ -0,0 +1,10 @@
+# Topics
+
+```eval_rst
+.. toctree::
+    :maxdepth: 3
+    :titlesonly:
+    :glob:
+
+    *
+```