Merge pull request inspirehep#23 from mihaibivol/refactors

Refactors

INSTALL.rst

@@ -1,2 +1,6 @@
 Installation
 ============
+
+json-merger is on PyPI so all you need is: ::
+
+    pip install json-merger

README.rst

@@ -41,9 +41,10 @@
         :target: https://github.com/inspirehep/json-merger/blob/master/LICENSE
 
 
-Invenio module that is able to merge json record objects.
-
-*This is an experimental developer preview release.*
+Module for merging JSON Objects.
 
 * Free software: GPLv2 license
 * Documentation: https://pythonhosted.org/json-merger/
+
+* For the simple use-case: ``pip install json-merger``
+* To install contrib dependencies: ``pip install json-merger[contrib]``

docs/api.rst

@@ -27,4 +27,29 @@ API Docs
 
 json_merger
 -----------
-
+.. autoclass:: json_merger.Merger
+
+json_merger.config
+------------------
+.. automodule:: json_merger.config
+    :members:
+
+json_merger.comparator
+----------------------
+.. automodule:: json_merger.comparator
+    :members:
+
+json_merger.stats
+-----------------
+.. automodule:: json_merger.stats
+    :members:
+
+json_merger.errors
+------------------
+.. automodule:: json_merger.errors
+    :members:
+
+json_merger.conflict
+--------------------
+.. automodule:: json_merger.conflict
+    :members:

docs/conf.py

@@ -52,6 +52,7 @@ def _warn_node(self, msg, node):
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -137,8 +138,8 @@ def _warn_node(self, msg, node):
 html_theme = 'alabaster'
 
 html_theme_options = {
-    'description': 'Invenio module that is able to merge json record objects.',
-    'github_user': 'inveniosoftware',
+    'description': 'Module for merging JSON objects.',
+    'github_user': 'inspirehep',
     'github_repo': 'json-merger',
     'github_button': False,
     'github_banner': True,
@@ -336,3 +337,6 @@ def _warn_node(self, msg, node):
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'https://docs.python.org/': None}
+
+# Also document __init__
+autoclass_content = 'both'