docs(docs): update sphinx docs

caizhengxin · Jan 2, 2020 · 629f069 · 629f069
1 parent 0e21c87
commit 629f069
Show file tree

Hide file tree

Showing 7 changed files with 86 additions and 2 deletions.
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
@@ -0,0 +1 @@
+.. include:: ../../CHANGELOG.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -1,3 +1,8 @@
+# -*- coding: utf-8 -*-
+# @Author: JanKinCai
+# @Date:   2019-12-30 21:47:52
+# @Last Modified by:   JanKinCai
+# @Last Modified time: 2020-01-02 12:40:57
 # Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full
@@ -34,6 +39,9 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
+    "sphinx.ext.extlinks",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
     "sphinx.ext.coverage",
     "sphinx.ext.githubpages",
     "sphinx.ext.inheritance_diagram",
@@ -62,3 +70,7 @@
 # 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']
+
+# TODO
+
+todo_include_todos = True
diff --git a/docs/source/datatype.rst b/docs/source/datatype.rst
@@ -0,0 +1,13 @@
+Support Data Type
+-----------------
+
+* boolean
+* string
+* int
+* float
+* list
+* choice
+* mac
+* ipv4
+* cidr, eg: ``192.168.1.1/24``
+* hex
diff --git a/docs/source/feature.rst b/docs/source/feature.rst
@@ -0,0 +1,7 @@
+Features
+--------
+
+* Interact input
+* Supports multiple data types
+* Support input check
+* Support regex
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,16 +4,17 @@
    contain the root `toctree` directive.
 
 Welcome to interact-cli's documentation!
-================================================
+========================================
 
 .. toctree::
    :maxdepth: 2
-   :caption: documentation:
+   :caption: documentation
 
    introduction
    installation
    usage
    modules
+   changelog
    api
 
 

diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst
@@ -1 +1,4 @@
+Introduction
+============
+
 .. include:: ../../README.rst
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,47 @@
+Interact cli
+============
+
+Interact
+--------
+
+.. automodule:: interact.__init__
+    :members:
+    :noindex:
+    :undoc-members:
+    :show-inheritance:
+
+Base
+----
+
+.. automodule:: interact.base
+    :members:
+    :noindex:
+    :undoc-members:
+    :show-inheritance:
+
+Fields
+------
+
+.. automodule:: interact.fields
+    :members:
+    :noindex:
+    :undoc-members:
+    :show-inheritance:
+
+When
+----
+
+.. automodule:: interact.when
+    :members:
+    :noindex:
+    :undoc-members:
+    :show-inheritance:
+
+Utils
+-----
+
+.. automodule:: interact.utils
+    :members:
+    :noindex:
+    :undoc-members:
+    :show-inheritance: