fix docs

Revolution1 · May 9, 2019 · cdd2ac1 · cdd2ac1
1 parent e1d2734
commit cdd2ac1
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 72 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -43,15 +43,15 @@ script: tox
 
 # After you create the Github repo and add it to Travis, run the
 # travis_pypi_setup.py script to finish PyPI deployment setup
-deploy:
-  provider: pypi
-  distributions: sdist bdist_wheel
-  user: revol
-  password:
-    secure: b/Ft9tCIAPddI7vkGCMZlkKWRi7Ahn73UMuXA+ZFhmTNQqM1SLjzUihfkrOJM5IzJC/42xCAxN6dgn2RpdqhJq5KhjlApFcPZawN1+S154jbjS/ss2Jn5ckryLFeITq8Fvud368r3i3EpqkEix0UK3QqMc5llnE/JtDPOS53azlKCetg6LAeMn4WrPwu74BC1lOSPG6fbW3OJ2o1Gu+/ToQrIoZUvy9yD7CyIto5OMIHI+hVV9TCJ8o6jQhAnWj5RxVJMmuONCpQ41cPVjIpvldakuxpFqH3mmGdPD7Nc4h7cmXbwthZLlBcI2oyFTxL9R5r4Sey8aFO/H5WaaBJMBauaAurLYkCVU4FIDxiTb/KwP09DnVWKlaXKB9Buv+LdO+IvG70VkkVFpeDxZ74VpvADoT+fx4gCSmPJiMDZGS2pxn7jcwH3qatWZ2aJZBg8DAMGNP+9AX+MNLFrPsipZQvl8Hq4DyztjLxjG//jwUwCzA5YrvXgBQmVQ40T64OZxTs//HS8GGE0zeb5FHwTXjomqp8bCOfIfpVwgmrkOY8d/fCz94JUtiUnU53EWqFQtfXiUIV5wAZzu5hVGGhghfw5yrgE4D/vp5ZwTH2/hY8n+VAOh4pimX0X+ob/LLMl4mnX64EPbwDKvx+beRPYxFBsOOZfAHoG6QszinVlao=
-  on:
-    tags: true
-    branch: master
-    python:
-      - 3.6
-      - 2.7
+#deploy:
+#  provider: pypi
+#  distributions: sdist bdist_wheel
+#  user: revol
+#  password:
+#    secure: b/Ft9tCIAPddI7vkGCMZlkKWRi7Ahn73UMuXA+ZFhmTNQqM1SLjzUihfkrOJM5IzJC/42xCAxN6dgn2RpdqhJq5KhjlApFcPZawN1+S154jbjS/ss2Jn5ckryLFeITq8Fvud368r3i3EpqkEix0UK3QqMc5llnE/JtDPOS53azlKCetg6LAeMn4WrPwu74BC1lOSPG6fbW3OJ2o1Gu+/ToQrIoZUvy9yD7CyIto5OMIHI+hVV9TCJ8o6jQhAnWj5RxVJMmuONCpQ41cPVjIpvldakuxpFqH3mmGdPD7Nc4h7cmXbwthZLlBcI2oyFTxL9R5r4Sey8aFO/H5WaaBJMBauaAurLYkCVU4FIDxiTb/KwP09DnVWKlaXKB9Buv+LdO+IvG70VkkVFpeDxZ74VpvADoT+fx4gCSmPJiMDZGS2pxn7jcwH3qatWZ2aJZBg8DAMGNP+9AX+MNLFrPsipZQvl8Hq4DyztjLxjG//jwUwCzA5YrvXgBQmVQ40T64OZxTs//HS8GGE0zeb5FHwTXjomqp8bCOfIfpVwgmrkOY8d/fCz94JUtiUnU53EWqFQtfXiUIV5wAZzu5hVGGhghfw5yrgE4D/vp5ZwTH2/hY8n+VAOh4pimX0X+ob/LLMl4mnX64EPbwDKvx+beRPYxFBsOOZfAHoG6QszinVlao=
+#  on:
+#    tags: true
+#    branch: master
+#    python:
+#      - 3.6
+#      - 2.7
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,36 @@
+# History
+
+## 0.1.6 (2019-05-9)
+
+- merge pull request [#90](https://github.com/Revolution1/etcd3-py/pull/90) Fix lease util keeping problems
+- merge pull request [#89](https://github.com/Revolution1/etcd3-py/pull/89) Add range end and lease to txn
+- merge pull request [#87](https://github.com/Revolution1/etcd3-py/pull/87) Add handel null value as gogoproto does while modelizing response data
+- merge pull request [#82](https://github.com/Revolution1/etcd3-py/pull/82) Fix watch util issue #18 and #78
+- merge pull request [#79](https://github.com/Revolution1/etcd3-py/pull/79) Improve etcd comapabitity of multiple versions
+- merge pull request [#51](https://github.com/Revolution1/etcd3-py/pull/51) Add a base EtcdModel to all dynamic created model
+- merge pull request [#42](https://github.com/Revolution1/etcd3-py/pull/42) Improve etcd comapabitity of multiple versions
+
+## 0.1.5 (2018-07-4)
+
+- merge pull request [#34](https://github.com/Revolution1/etcd3-py/pull/34) enum34 only where it's needed
+
+## 0.1.4 (2018-03-30)
+
+- better code quality
+- support etcd v3.2.2+
+
+## 0.1.3 (2018-03-21)
+
+- finished lock util
+
+## 0.1.2 (2018-03-20)
+
+- Add more test
+- Add watcher, transaction and lease util
+
+You can try it at dev environment
+
+## 0.1.0 (2018-03-19)
+
+- Implemented all APIs of etcd3's gRPC-JSON-Gateway
+- Stateful utils (Watcher Lease Lock Transaction) are in progress
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,6 +1,6 @@
 include AUTHORS.rst
 include CONTRIBUTING.rst
-include CHANGELOG.rst
+include CHANGELOG.md
 include LICENSE
 include README.md
 include requirements*.txt

diff --git a/Makefile b/Makefile
@@ -75,14 +75,15 @@ servedocs: docs ## compile the docs watching for changes
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 
 release: clean dist ## package and upload a release
-	python setup.py sdist upload
-	python setup.py bdist_wheel upload
+#	python setup.py sdist upload
+#	python setup.py bdist_wheel upload
 
 dist: clean ## builds source and wheel package
-	m2r --dry-run README.md > README.rst
+#	m2r --dry-run README.md > README.rst
 	python setup.py sdist
 	python setup.py bdist_wheel
 	ls -l dist
+	twine check dist/*
 
 upload: dist
 	twine upload dist/*

diff --git a/docs/history.rst b/docs/history.rst
@@ -1 +1 @@
-.. include:: ../CHANGELOG.rst
+.. mdinclude:: ../CHANGELOG.md
diff --git a/requirements_dev.txt b/requirements_dev.txt
@@ -19,3 +19,4 @@ m2r==0.2.1
 codecov>=1.4.0
 codacy-coverage==1.3.11
 twine>=1.13.0
+readme_renderer[md]
diff --git a/setup.py b/setup.py
@@ -18,13 +18,10 @@
 print(SHORT_DESCRIPTION)
 print(os.listdir(os.curdir))
 
-readme_path = 'README.md'
-if os.path.isfile('README.rst'):
-    readme_path = 'README.rst'
-with open(readme_path) as readme_file:
+with open('README.md') as readme_file:
     readme = readme_file.read()
 
-with open('CHANGELOG.rst') as history_file:
+with open('CHANGELOG.md') as history_file:
     history = history_file.read()
 
 # parse_requirements() returns generator of pip.req.InstallRequirement objects
@@ -54,6 +51,7 @@
     version='0.1.6',
     description=SHORT_DESCRIPTION,
     long_description=readme + '\n\n' + history,
+    long_description_content_type="text/markdown",
     author="Renjie Cai",
     author_email='[email protected]',
     url='https://github.com/revolution1/etcd3-py',