update docs

gyli · Oct 5, 2019 · 9a14edd · 9a14edd
1 parent afc6490
commit 9a14edd
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -6,9 +6,9 @@ Documentation: [http://pywaffle.readthedocs.io](http://pywaffle.readthedocs.io)
 
 ## Introduction
 
-PyWaffle is a Python package to make waffle chart, bases on [Matplotlib](https://matplotlib.org/).
+PyWaffle is a Python package to plot waffle chart.
 
-It provides a [Figure constructor class](https://matplotlib.org/gallery/subplots_axes_and_figures/custom_figure_class.html) `Waffle`, which could be passed to [matplotlib.pyplot.figure](https://matplotlib.org/api/_as_gen/matplotlib.pyplot.figure.html) and generates a matplotlib Figure object.
+It provides a [Figure constructor class](https://matplotlib.org/gallery/subplots_axes_and_figures/custom_figure_class.html) `Waffle`, which could be passed to [matplotlib.pyplot.figure](https://matplotlib.org/api/_as_gen/matplotlib.pyplot.figure.html) and generate a matplotlib Figure object.
 
 ## Installation
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -41,6 +41,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.intersphinx',
+    'recommonmark'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -49,8 +50,8 @@
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
-# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'

diff --git a/docs/examples.rst b/docs/examples.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,10 +3,13 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to PyWaffle's documentation!
-====================================
+PyWaffle Documentation
+======================
 
-PyWaffle: Make Waffle Charts in Python
+PyWaffle is a Python package to plot waffle chart.
+
+A `Figure constructor class
+<https://matplotlib.org/gallery/subplots_axes_and_figures/custom_figure_class.html>`_ Waffle is provided, which could be passed to matplotlib.pyplot.figure and generate a matplotlib Figure object.
 
 .. toctree::
    :maxdepth: 2

diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -1,3 +1,4 @@
 matplotlib
 pandas
+recommonmark
 sphinx