Răsfoiți Sursa

[update] :heavy_check_mark: readthedocs

jhao 6 ani în urmă
părinte
comite
2a4fd089f0
2 a modificat fișierele cu 25 adăugiri și 4 ștergeri
  1. 11 4
      docs/conf.py
  2. 14 0
      docs/index.rst

+ 11 - 4
docs/conf.py

@@ -13,7 +13,7 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+import sphinx_rtd_theme
 
 # -- Project information -----------------------------------------------------
 
@@ -26,7 +26,6 @@ master_doc = 'index'
 # The full version, including alpha/beta/rc tags
 release = '2.1.0'
 
-
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -35,6 +34,13 @@ release = '2.1.0'
 extensions = [
 ]
 
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = "sphinx"
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -50,7 +56,6 @@ language = 'zh_CN'
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -58,7 +63,9 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 #
 html_theme = 'sphinx_rtd_theme'
 
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
 # 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']
+html_static_path = ['_static']

+ 14 - 0
docs/index.rst

@@ -6,6 +6,20 @@
 ProxyPool
 =====================================
 
+::
+
+   ****************************************************************
+   *** ______  ********************* ______ *********** _  ********
+   *** | ___ \_ ******************** | ___ \ ********* | | ********
+   *** | |_/ / \__ __   __  _ __   _ | |_/ /___ * ___  | | ********
+   *** |  __/|  _// _ \ \ \/ /| | | ||  __// _ \ / _ \ | | ********
+   *** | |   | | | (_) | >  < \ |_| || |  | (_) | (_) || |___  ****
+   *** \_|   |_|  \___/ /_/\_\ \__  |\_|   \___/ \___/ \_____/ ****
+   ****                       __ / /                          *****
+   ************************* /___ / *******************************
+   *************************       ********************************
+   ****************************************************************
+
 Python爬虫代理IP池
 
 安装