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.
This commit is contained in:
parent
9914f7edef
commit
43443d6057
@ -20,6 +20,8 @@ If you're developing on 0x now or are interested in using 0x infrastructure in t
|
|||||||
|
|
||||||
### Published Packages
|
### Published Packages
|
||||||
|
|
||||||
|
#### TypeScript/JavaScript
|
||||||
|
|
||||||
| Package | Version | Description |
|
| Package | Version | Description |
|
||||||
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
||||||
| [`0x.js`](/packages/0x.js) | [](https://www.npmjs.com/package/0x.js) | A Javascript library for interacting with the 0x protocol |
|
| [`0x.js`](/packages/0x.js) | [](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) | [](https://www.npmjs.com/package/@0x/utils) | Shared utilities |
|
| [`@0x/utils`](/packages/utils) | [](https://www.npmjs.com/package/@0x/utils) | Shared utilities |
|
||||||
| [`@0x/web3-wrapper`](/packages/web3-wrapper) | [](https://www.npmjs.com/package/@0x/web3-wrapper) | Web3 wrapper |
|
| [`@0x/web3-wrapper`](/packages/web3-wrapper) | [](https://www.npmjs.com/package/@0x/web3-wrapper) | Web3 wrapper |
|
||||||
|
|
||||||
|
#### Python
|
||||||
|
|
||||||
|
| Package | Version | Description |
|
||||||
|
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||||
|
| [`0x-order-utils.py`](/python-packages/order_utils) | [](https://pypi.org/project/0x-order-utils/) | A set of utilities for generating, parsing, signing and validating 0x orders |
|
||||||
|
|
||||||
### Private Packages
|
### Private Packages
|
||||||
|
|
||||||
| Package | Description |
|
| Package | Description |
|
||||||
|
13
python-packages/order_utils/.discharge.json
Normal file
13
python-packages/order_utils/.discharge.json
Normal 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,7 +2,7 @@
|
|||||||
|
|
||||||
0x order-related utilities for those developing on top of 0x protocol.
|
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
|
## Installing
|
||||||
|
|
||||||
|
@ -116,6 +116,19 @@ class PublishCommand(distutils.command.build_py.build_py):
|
|||||||
subprocess.check_call("twine upload dist/*".split()) # nosec
|
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):
|
class GanacheCommand(distutils.command.build_py.build_py):
|
||||||
"""Custom command to publish to pypi.org."""
|
"""Custom command to publish to pypi.org."""
|
||||||
|
|
||||||
@ -141,7 +154,7 @@ with open("README.md", "r") as file_handle:
|
|||||||
|
|
||||||
setup(
|
setup(
|
||||||
name="0x-order-utils",
|
name="0x-order-utils",
|
||||||
version="0.1.0",
|
version="1.0.1",
|
||||||
description="Order utilities for 0x applications",
|
description="Order utilities for 0x applications",
|
||||||
long_description=README_MD,
|
long_description=README_MD,
|
||||||
long_description_content_type="text/markdown",
|
long_description_content_type="text/markdown",
|
||||||
@ -154,6 +167,7 @@ setup(
|
|||||||
"test": TestCommandExtension,
|
"test": TestCommandExtension,
|
||||||
"test_publish": TestPublishCommand,
|
"test_publish": TestPublishCommand,
|
||||||
"publish": PublishCommand,
|
"publish": PublishCommand,
|
||||||
|
"publish_docs": PublishDocsCommand,
|
||||||
"ganache": GanacheCommand,
|
"ganache": GanacheCommand,
|
||||||
},
|
},
|
||||||
install_requires=[
|
install_requires=[
|
||||||
|
Loading…
x
Reference in New Issue
Block a user