Merge pull request #21 from OpenDataServices/for-fork

fork & release: add Changelog, docs, edit readme and setup
OpenDataServices · May 29, 2020 · 88e422b · 88e422b
2 parents 5e7429d + 965528e
commit 88e422b
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+
+## [0.1.0] - 2020-05-29
+
+First release of new forked project
diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
-sphinxcontrib-jsonschema
-========================
+sphinxcontrib-opendataservices-jsonschema
+=========================================
 
-`sphinxcontrib-jsonschema` is Sphinx extension to define data structure using `JSON Schema`_
+`sphinxcontrib-opendataservices-jsonschema` is Sphinx extension to define data structure using `JSON Schema`_
 
 .. _JSON Schema: http://json-schema.org/
 
@@ -15,3 +15,21 @@ Include this extension in conf.py::
 Write ``jsonschema`` directive into reST file where you want to import schema::
 
     .. jsonschema:: path/to/your.json
+
+
+Docs
+----
+
+https://sphinxcontrib-opendataservices-jsonschema.readthedocs.io/en/latest/ , or see the docs folder in this repository
+
+PyPi
+----
+
+Available at https://pypi.org/project/sphinxcontrib-opendataservices-jsonschema/
+
+Don't install this package and https://pypi.org/project/sphinxcontrib-jsonschema/ at the same time, as they use the same Python namespace.
+
+History
+-------
+
+This project was started as https://github.com/tk0miya/sphinxcontrib-jsonschema and forked by Open Data Services Co-operative in May 2020. Thanks to all the original authors.
diff --git a/docs/conf.py b/docs/conf.py
@@ -0,0 +1,5 @@
+
+project = 'sphinxcontrib-opendataservices-jsonschema'
+
+master_doc = 'index'
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,7 @@
+sphinxcontrib-opendataservices-jsonschema
+=========================================
+
+A JSON Schema widget for Sphinx
+
+More to come.
+
diff --git a/setup.py b/setup.py
@@ -12,12 +12,12 @@
 ]
 
 setup(
-    name='sphinxcontrib-jsonschema',
-    version='0.9.3',
-    url='https://github.com/tk0miya/sphinxcontrib-jsonschema',
+    name='sphinxcontrib-opendataservices-jsonschema',
+    version='0.1.0',
+    url='https://github.com/OpenDataServices/sphinxcontrib-opendataservices-jsonschema',
     license='BSD',
-    author='Takeshi KOMIYA',
-    author_email='i.tkomiya@gmail.com',
+    author='Takeshi KOMIYA & Open Data Services Co-operative',
+    author_email='code@opendataservices.coop',
     description='Sphinx extension to define data structure using JSON Schema',
     long_description=long_desc,
     zip_safe=False,