diff options
| author | F. Eugene Aumson <feuGeneA@users.noreply.github.com> | 2018-11-17 20:07:25 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-17 20:07:25 +0800 |
| commit | 43443d6057da64e972511e3a79334407874d2084 (patch) | |
| tree | 811ef884ed0e314574768da001b5a4359d884091 /python-packages/order_utils | |
| parent | 9914f7edefa96c564768233ab6a1f21b0835a49f (diff) | |
| download | dexon-sol-tools-43443d6057da64e972511e3a79334407874d2084.tar.gz 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.
Diffstat (limited to 'python-packages/order_utils')
| -rw-r--r-- | python-packages/order_utils/.discharge.json | 13 | ||||
| -rw-r--r-- | python-packages/order_utils/README.md | 2 | ||||
| -rwxr-xr-x | python-packages/order_utils/setup.py | 16 |
3 files changed, 29 insertions, 2 deletions
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=[ |