diff --git a/README.md b/README.md index a52f925c..a30c09fb 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,9 @@ $ pip install vortexasdk Set your `VORTEXA_API_KEY` environment variable, that's all. +Refer to [Vortexa API Authentication](https://docs.vortexa.com/reference/intro-authentication) + for more details, including instructions on where to find your API key. + ##### Example ```python diff --git a/docs/build_docs.sh b/docs/build_docs.sh index 8f036eaa..4309593c 100755 --- a/docs/build_docs.sh +++ b/docs/build_docs.sh @@ -1,4 +1,5 @@ #!/bin/bash +mkdir -p ./_build/pydocmd/examples python docs/autogen.py pydocmd build diff --git a/docs/config/config.md b/docs/config/config.md new file mode 100644 index 00000000..09354189 --- /dev/null +++ b/docs/config/config.md @@ -0,0 +1,9 @@ +## Config + +The VortexaSDK can be configured using environment variables. + +| Environment Variable | Default | Description | +|:----------------------|:--------------------------------|:-------------------------| +| VORTEXA_API_KEY | none | API Key used to access the VortexaAPI. Refer to [Vortexa API Authentication](https://docs.vortexa.com/reference/intro-authentication) for more details, including instructions on where to find your API key.| +| LOG_FILE | vortexasdk.log | Output log file | +| LOG_LEVEL | INFO | Configure the level of must be one of `["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]` | \ No newline at end of file diff --git a/docs/deploy_docs.sh b/docs/deploy_docs.sh index 5081c448..4b70388f 100755 --- a/docs/deploy_docs.sh +++ b/docs/deploy_docs.sh @@ -1,4 +1,5 @@ #!/bin/bash +mkdir -p ./_build/pydocmd/examples python docs/autogen.py pydocmd gh-deploy diff --git a/docs/entities/about-entities.md b/docs/entities/about-entities.md deleted file mode 100644 index 832e62fa..00000000 --- a/docs/entities/about-entities.md +++ /dev/null @@ -1 +0,0 @@ -## Vortexa SDK Entities diff --git a/docs/serve_docs.sh b/docs/serve_docs.sh index 759e9d55..81ab1829 100755 --- a/docs/serve_docs.sh +++ b/docs/serve_docs.sh @@ -1,4 +1,5 @@ #!/bin/bash +mkdir -p ./_build/pydocmd/examples python docs/autogen.py pydocmd serve diff --git a/pydocmd.yml b/pydocmd.yml index e07a5f6f..40a97fb6 100644 --- a/pydocmd.yml +++ b/pydocmd.yml @@ -16,7 +16,6 @@ generate: - endpoints/products.md: - vortexasdk.endpoints.products++ - vortexasdk.endpoints.products_result++ - - entities/product.md: - vortexasdk.api.product++ - entities/geography.md: @@ -37,15 +36,14 @@ pages: Products: endpoints/products.md Vessels: endpoints/vessels.md - Entities: -# About Entities: entities/about-entities.md << docs/entities/about-entities.md Cargo Movement: entities/cargo_movement.md Corporation: entities/corporation.md Geography: entities/geography.md Product: entities/product.md Vessel: entities/vessel.md + - Config: config.md << docs/config/config.md - Examples: 1 China VLCC Discharges: examples/1_china.md - theme: name: readthedocs collapse_navigation: true