From b89cc306d117a038f3763b6d5391cbc9a62f6134 Mon Sep 17 00:00:00 2001
From: Gabriel Altay <gabriel.altay@gmail.com>
Date: Wed, 10 Apr 2019 16:01:09 -0400
Subject: [PATCH] split README.rst and docs/readme.rst (#23)

* split README.rst and docs/readme.rst

* split README.rst and docs/readme.rst
---
 CHANGELOG.rst         |   7 +++
 README.rst            |  20 +++-----
 docs/readme.rst       | 110 +++++++++++++++++++++++++++++++++++++++++-
 qwikidata/__init__.py |   2 +-
 4 files changed, 123 insertions(+), 16 deletions(-)

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 99de2e0..5eadb4d 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -2,6 +2,13 @@
 qwikidata Change Log
 ====================
 
+v0.3.1
+======
+
+**Fixed**:
+
+* rendering issues due to linked README.rst and docs/readme.rst
+
 v0.3.0
 ======
 
diff --git a/README.rst b/README.rst
index 627e80b..812d2b7 100644
--- a/README.rst
+++ b/README.rst
@@ -46,23 +46,13 @@ You can install the most recent version using pip,
 Quick Examples
 ==============
 
+Please see the,
 
-Linked Data Interface
----------------------
+* `examples folder`_
 
-.. literalinclude:: ../examples/basic_linked_data_interface.py
+OR
 
-
-SPARQL Query Service
---------------------
-
-.. literalinclude:: ../examples/basic_sparql_query_service.py
-
-
-JSON Dump
----------
-
-.. literalinclude:: ../examples/basic_json_dump.py
+* `readthedocs`_
 
 
 
@@ -107,3 +97,5 @@ Copyright 2019 Kensho Technologies, LLC.
 .. _linked data interface: https://www.wikidata.org/wiki/Wikidata:Data_access
 .. _sparql query service: https://www.wikidata.org/wiki/Wikidata:SPARQL_query_service
 .. _json dump: https://www.wikidata.org/wiki/Wikidata:Database_download
+.. _examples folder: https://github.com/kensho-technologies/qwikidata/tree/master/examples
+.. _readthedocs: https://qwikidata.readthedocs.io/en/stable/readme.html
diff --git a/docs/readme.rst b/docs/readme.rst
index 72a3355..627e80b 100644
--- a/docs/readme.rst
+++ b/docs/readme.rst
@@ -1 +1,109 @@
-.. include:: ../README.rst
+=======
+Welcome
+=======
+
+|build-status|
+|docs|
+|license|
+|pypi-python|
+|pypi-version|
+
+
+`qwikidata` is a Python package with tools that allow you to interact with Wikidata_.
+
+The package defines a set of classes that allow you to represent Wikidata entities
+in a Pythonic way.  It also provides a Pythonic way to access three data sources,
+
+* `linked data interface`_
+* `sparql query service`_
+* `json dump`_
+
+Important Links
+===============
+
+* documentation: https://qwikidata.rtfd.io/
+* PyPI: https://pypi.org/project/qwikidata/
+* github: https://github.com/kensho-technologies/qwikidata/
+
+Quick Install
+=============
+
+Requirements
+------------
+
+* python >= 3.6
+
+Install with pip
+----------------
+
+You can install the most recent version using pip,
+
+.. code-block:: bash
+
+  pip install qwikidata
+
+
+Quick Examples
+==============
+
+
+Linked Data Interface
+---------------------
+
+.. literalinclude:: ../examples/basic_linked_data_interface.py
+
+
+SPARQL Query Service
+--------------------
+
+.. literalinclude:: ../examples/basic_sparql_query_service.py
+
+
+JSON Dump
+---------
+
+.. literalinclude:: ../examples/basic_json_dump.py
+
+
+
+License
+=======
+
+Licensed under the Apache 2.0 License. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+
+Copyright
+=========
+
+Copyright 2019 Kensho Technologies, LLC.
+
+
+.. |build-status| image:: https://img.shields.io/travis/kensho-technologies/qwikidata.svg?style=flat
+    :alt: Build Status
+    :scale: 100%
+    :target: https://travis-ci.org/kensho-technologies/qwikidata
+
+.. |docs| image:: https://readthedocs.org/projects/qwikidata/badge/?version=latest
+    :alt: Documentation Status
+    :scale: 100%
+    :target: https://qwikidata.readthedocs.io/en/latest/?badge=latest
+
+.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
+    :alt: License
+    :scale: 100%
+    :target: https://opensource.org/licenses/Apache-2.0
+
+.. |pypi-python| image:: https://img.shields.io/pypi/pyversions/qwikidata.svg
+    :alt: PyPI Python
+    :scale: 100%
+    :target: https://pypi.python.org/pypi/qwikidata
+
+.. |pypi-version| image:: https://img.shields.io/pypi/v/qwikidata.svg
+   :alt: PyPI Version
+   :scale: 100%
+   :target: https://pypi.python.org/pypi/qwikidata
+
+
+.. _Wikidata: https://www.wikidata.org/wiki/Wikidata:Main_Page
+.. _linked data interface: https://www.wikidata.org/wiki/Wikidata:Data_access
+.. _sparql query service: https://www.wikidata.org/wiki/Wikidata:SPARQL_query_service
+.. _json dump: https://www.wikidata.org/wiki/Wikidata:Database_download
diff --git a/qwikidata/__init__.py b/qwikidata/__init__.py
index 403b9af..0ea8ac3 100644
--- a/qwikidata/__init__.py
+++ b/qwikidata/__init__.py
@@ -2,4 +2,4 @@
 """Metadata for this package."""
 
 __package_name__ = "qwikidata"
-__version__ = "0.3.0"
+__version__ = "0.3.1"