Sphinx readme md (#202)

* Fix Parameters typo

* Almost working documentation generation

* Remove genarted html files, update conf and index

* Update docs/conf.py

* Add docs/source files

* Prevent creation of modules.rst; update index.rst

* Move conf.py and index.rst to docs/source

* Add opening paragraph to index.rst

* Fix flake8 issues

* Add dummy text

* Add dummy text 2

* Update conf.py to use recommonmark; add README.md to RTD documentation

* Update requirements.txt with recommonmark

* Create symlink to README

* Add opening line to index.rst

* Fix flake8 conf.py issue

docs/source/README.md

@@ -0,0 +1 @@
+../../README.md

docs/source/conf.py

@@ -19,6 +19,7 @@
 #
 import os
 import sys
+from recommonmark.parser import CommonMarkParser
 sys.path.insert(0, os.path.abspath('../../'))
 # sys.path.insert(0, os.path.abspath('../'))
 
@@ -43,8 +44,9 @@ 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'
+source_parsers = {'.md': CommonMarkParser}
+source_suffix = ['.rst', '.md']
+# source_suffix = '.rst'
 
 # The master toctree document.
 master_doc = 'index'

docs/source/index.rst

@@ -6,11 +6,17 @@
 Buku
 ====
 
-`buku <https://github.com/jarun/buku>`_ is a powerful bookmark manager written in Python3 and SQLite3. When I started writing it, I couldn’t find a flexible cmdline solution with a private, portable, merge-able database along with browser integration. Hence, Buku (after my son’s nickname, meaning close to the heart in my language).
+A highly delicious bookmark manager. Your mini web!
 
 .. toctree::
    :maxdepth: 2
-   :caption: Table of Contents
+   :caption: README
+
+   README.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Documentation
 
    Buku <buku>
 

requirements.txt

@@ -2,3 +2,4 @@ urllib3>=1.13.1
 beautifulsoup4>=4.4.1
 cryptography>=1.2.3
 requests>=2.9.1
+recommonmark>=0.4.0