diff --git a/docs/source/Enums.rst b/docs/source/Enums.rst new file mode 100644 index 00000000..f59e077f --- /dev/null +++ b/docs/source/Enums.rst @@ -0,0 +1,96 @@ +.. _enums_header: + +Enums +============================================================== + +============================================================== +Sort +============================================================== +.. autoclass:: polygon.rest.models.Sort + :members: + :undoc-members: + +============================================================== +Order +============================================================== +.. autoclass:: polygon.rest.models.Order + :members: + :undoc-members: + +============================================================== +Locale +============================================================== +.. autoclass:: polygon.rest.models.Locale + :members: + :undoc-members: + +============================================================== +Market +============================================================== +.. autoclass:: polygon.rest.models.Market + :members: + :undoc-members: + +============================================================== +AssetClass +============================================================== +.. autoclass:: polygon.rest.models.AssetClass + :members: + :undoc-members: + +============================================================== +DividendType +============================================================== +.. autoclass:: polygon.rest.models.DividendType + :members: + :undoc-members: + +============================================================== +Frequency +============================================================== +.. autoclass:: polygon.rest.models.Frequency + :members: + :undoc-members: + +============================================================== +DataType +============================================================== +.. autoclass:: polygon.rest.models.DataType + :members: + :undoc-members: + +============================================================== +SIP +============================================================== +.. autoclass:: polygon.rest.models.SIP + :members: + :undoc-members: + +============================================================== +ExchangeType +============================================================== +.. autoclass:: polygon.rest.models.ExchangeType + :members: + :undoc-members: + +============================================================== +Direction +============================================================== +.. autoclass:: polygon.rest.models.Direction + :members: + :undoc-members: + +============================================================== +SnapshotMarketType +============================================================== +.. autoclass:: polygon.rest.models.SnapshotMarketType + :members: + :undoc-members: + +============================================================== +Timeframe +============================================================== +.. autoclass:: polygon.rest.models.Timeframe + :members: + :undoc-members: + diff --git a/docs/source/Models.rst b/docs/source/Models.rst index c003b4c9..05dcb437 100644 --- a/docs/source/Models.rst +++ b/docs/source/Models.rst @@ -192,6 +192,3 @@ Condition Exchange ============================================================== .. autoclass:: polygon.rest.models.Exchange - - - diff --git a/docs/source/index.rst b/docs/source/index.rst index 35a50003..dab96872 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,6 +16,7 @@ This documentation is for the Python client only. For details about the response Trades vX Models + Enums Indices and tables diff --git a/polygon/rest/models/__init__.py b/polygon/rest/models/__init__.py index d6edfd09..ce0103be 100644 --- a/polygon/rest/models/__init__.py +++ b/polygon/rest/models/__init__.py @@ -1,4 +1,4 @@ -from .shared import * +from .common import * from .aggs import * from .trades import * from .quotes import * diff --git a/polygon/rest/models/shared.py b/polygon/rest/models/common.py similarity index 100% rename from polygon/rest/models/shared.py rename to polygon/rest/models/common.py diff --git a/polygon/rest/models/conditions.py b/polygon/rest/models/conditions.py index d1cb2801..32a268d0 100644 --- a/polygon/rest/models/conditions.py +++ b/polygon/rest/models/conditions.py @@ -1,5 +1,5 @@ from typing import Optional -from .shared import AssetClass, DataType +from .common import AssetClass, DataType from dataclasses import dataclass diff --git a/polygon/rest/models/dividends.py b/polygon/rest/models/dividends.py index f70adf9f..014e5d4d 100644 --- a/polygon/rest/models/dividends.py +++ b/polygon/rest/models/dividends.py @@ -1,5 +1,5 @@ from typing import Optional -from .shared import DividendType, Frequency +from .common import DividendType, Frequency from dataclasses import dataclass diff --git a/polygon/rest/models/exchanges.py b/polygon/rest/models/exchanges.py index 64527710..1cd0e07d 100644 --- a/polygon/rest/models/exchanges.py +++ b/polygon/rest/models/exchanges.py @@ -1,5 +1,5 @@ from typing import Optional -from .shared import AssetClass, Locale, ExchangeType +from .common import AssetClass, Locale, ExchangeType from dataclasses import dataclass diff --git a/polygon/rest/models/tickers.py b/polygon/rest/models/tickers.py index f0b52e48..767fe5ca 100644 --- a/polygon/rest/models/tickers.py +++ b/polygon/rest/models/tickers.py @@ -1,5 +1,5 @@ from typing import Optional, List -from .shared import Locale, Market, AssetClass +from .common import Locale, Market, AssetClass from dataclasses import dataclass