crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(order_utils.py): publish docs to S3, not RTD (#1264)

Browse Source 
Publishing to readthedocs.io (RTD) wasn't working, for various reasons.

Changed to publish docs to S3.
This commit is contained in:
F. Eugene Aumson
2018-11-17 07:07:25 -05:00
committed by GitHub
parent 9914f7edef
commit 43443d6057
4 changed files with 37 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -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 |

13
python-packages/order_utils/.discharge.json Normal file
View File

@@ -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
}

2
python-packages/order_utils/README.md
View File

@@ -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

16
python-packages/order_utils/setup.py
View File

@@ -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=[