aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorF. Eugene Aumson <feuGeneA@users.noreply.github.com>2018-11-17 20:07:25 +0800
committerGitHub <noreply@github.com>2018-11-17 20:07:25 +0800
commit43443d6057da64e972511e3a79334407874d2084 (patch)
tree811ef884ed0e314574768da001b5a4359d884091
parent9914f7edefa96c564768233ab6a1f21b0835a49f (diff)
downloaddexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.tar
dexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.tar.gz
dexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.tar.bz2
dexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.tar.lz
dexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.tar.xz
dexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.tar.zst
dexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.zip
fix(order_utils.py): publish docs to S3, not RTD (#1264)
Publishing to readthedocs.io (RTD) wasn't working, for various reasons. Changed to publish docs to S3.
-rw-r--r--README.md8
-rw-r--r--python-packages/order_utils/.discharge.json13
-rw-r--r--python-packages/order_utils/README.md2
-rwxr-xr-xpython-packages/order_utils/setup.py16
4 files changed, 37 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5ceae41ba..90810f089 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,8 @@ If you're developing on 0x now or are interested in using 0x infrastructure in t
### Published Packages
+#### TypeScript/JavaScript
+
| Package | Version | Description |
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| [`0x.js`](/packages/0x.js) | [![npm](https://img.shields.io/npm/v/0x.js.svg)](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol |
@@ -52,6 +54,12 @@ If you're developing on 0x now or are interested in using 0x infrastructure in t
| [`@0x/utils`](/packages/utils) | [![npm](https://img.shields.io/npm/v/@0x/utils.svg)](https://www.npmjs.com/package/@0x/utils) | Shared utilities |
| [`@0x/web3-wrapper`](/packages/web3-wrapper) | [![npm](https://img.shields.io/npm/v/@0x/web3-wrapper.svg)](https://www.npmjs.com/package/@0x/web3-wrapper) | Web3 wrapper |
+#### Python
+
+| Package | Version | Description |
+| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
+| [`0x-order-utils.py`](/python-packages/order_utils) | [![PyPI](https://img.shields.io/pypi/v/0x-order-utils.svg)](https://pypi.org/project/0x-order-utils/) | A set of utilities for generating, parsing, signing and validating 0x orders |
+
### Private Packages
| Package | Description |
diff --git a/python-packages/order_utils/.discharge.json b/python-packages/order_utils/.discharge.json
new file mode 100644
index 000000000..2b14aa023
--- /dev/null
+++ b/python-packages/order_utils/.discharge.json
@@ -0,0 +1,13 @@
+{
+ "domain": "0x-order-utils-py",
+ "build_command": "python setup.py build_sphinx",
+ "upload_directory": "build/docs/html",
+ "index_key": "index.html",
+ "error_key": "index.html",
+ "trailing_slashes": true,
+ "cache": 3600,
+ "aws_profile": "default",
+ "aws_region": "us-east-1",
+ "cdn": false,
+ "dns_configured": true
+}
diff --git a/python-packages/order_utils/README.md b/python-packages/order_utils/README.md
index 4c5f7627c..2181c7a11 100644
--- a/python-packages/order_utils/README.md
+++ b/python-packages/order_utils/README.md
@@ -2,7 +2,7 @@
0x order-related utilities for those developing on top of 0x protocol.
-Read the [documentation](https://0x.readthedocs.io/projects/order-utils/en/latest/)
+Read the [documentation](http://0x-order-utils-py.s3-website-us-east-1.amazonaws.com/)
## Installing
diff --git a/python-packages/order_utils/setup.py b/python-packages/order_utils/setup.py
index 679bfb4b2..125de5ff7 100755
--- a/python-packages/order_utils/setup.py
+++ b/python-packages/order_utils/setup.py
@@ -116,6 +116,19 @@ class PublishCommand(distutils.command.build_py.build_py):
subprocess.check_call("twine upload dist/*".split()) # nosec
+class PublishDocsCommand(distutils.command.build_py.build_py):
+ """Custom command to publish docs to S3."""
+
+ description = (
+ "Publish docs to "
+ + "http://0x-order-utils-py.s3-website-us-east-1.amazonaws.com/"
+ )
+
+ def run(self):
+ """Run npm package `discharge` to build & upload docs."""
+ subprocess.check_call("discharge deploy".split()) # nosec
+
+
class GanacheCommand(distutils.command.build_py.build_py):
"""Custom command to publish to pypi.org."""
@@ -141,7 +154,7 @@ with open("README.md", "r") as file_handle:
setup(
name="0x-order-utils",
- version="0.1.0",
+ version="1.0.1",
description="Order utilities for 0x applications",
long_description=README_MD,
long_description_content_type="text/markdown",
@@ -154,6 +167,7 @@ setup(
"test": TestCommandExtension,
"test_publish": TestPublishCommand,
"publish": PublishCommand,
+ "publish_docs": PublishDocsCommand,
"ganache": GanacheCommand,
},
install_requires=[