Skip to content

Commit d7bff2d

Browse files
Darcy-LindeDarcy-Linde
authored
Add Enums to docs (#154)
1 parent 3876c3e commit d7bff2d

File tree

9 files changed

+102
-8
lines changed

9 files changed

+102
-8
lines changed

‎docs/source/Enums.rst

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
.. _enums_header:
2+
3+
Enums
4+
==============================================================
5+
6+
==============================================================
7+
Sort
8+
==============================================================
9+
.. autoclass:: polygon.rest.models.Sort
10+
:members:
11+
:undoc-members:
12+
13+
==============================================================
14+
Order
15+
==============================================================
16+
.. autoclass:: polygon.rest.models.Order
17+
:members:
18+
:undoc-members:
19+
20+
==============================================================
21+
Locale
22+
==============================================================
23+
.. autoclass:: polygon.rest.models.Locale
24+
:members:
25+
:undoc-members:
26+
27+
==============================================================
28+
Market
29+
==============================================================
30+
.. autoclass:: polygon.rest.models.Market
31+
:members:
32+
:undoc-members:
33+
34+
==============================================================
35+
AssetClass
36+
==============================================================
37+
.. autoclass:: polygon.rest.models.AssetClass
38+
:members:
39+
:undoc-members:
40+
41+
==============================================================
42+
DividendType
43+
==============================================================
44+
.. autoclass:: polygon.rest.models.DividendType
45+
:members:
46+
:undoc-members:
47+
48+
==============================================================
49+
Frequency
50+
==============================================================
51+
.. autoclass:: polygon.rest.models.Frequency
52+
:members:
53+
:undoc-members:
54+
55+
==============================================================
56+
DataType
57+
==============================================================
58+
.. autoclass:: polygon.rest.models.DataType
59+
:members:
60+
:undoc-members:
61+
62+
==============================================================
63+
SIP
64+
==============================================================
65+
.. autoclass:: polygon.rest.models.SIP
66+
:members:
67+
:undoc-members:
68+
69+
==============================================================
70+
ExchangeType
71+
==============================================================
72+
.. autoclass:: polygon.rest.models.ExchangeType
73+
:members:
74+
:undoc-members:
75+
76+
==============================================================
77+
Direction
78+
==============================================================
79+
.. autoclass:: polygon.rest.models.Direction
80+
:members:
81+
:undoc-members:
82+
83+
==============================================================
84+
SnapshotMarketType
85+
==============================================================
86+
.. autoclass:: polygon.rest.models.SnapshotMarketType
87+
:members:
88+
:undoc-members:
89+
90+
==============================================================
91+
Timeframe
92+
==============================================================
93+
.. autoclass:: polygon.rest.models.Timeframe
94+
:members:
95+
:undoc-members:
96+

‎docs/source/Models.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,3 @@ Condition
192192
Exchange
193193
==============================================================
194194
.. autoclass:: polygon.rest.models.Exchange
195-
196-
197-

‎docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This documentation is for the Python client only. For details about the response
1616
Trades
1717
vX
1818
Models
19+
Enums
1920

2021

2122
Indices and tables

‎polygon/rest/models/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from .shared import *
1+
from .common import *
22
from .aggs import *
33
from .trades import *
44
from .quotes import *

‎polygon/rest/models/shared.py renamed to ‎polygon/rest/models/common.py

File renamed without changes.

‎polygon/rest/models/conditions.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from typing import Optional
2-
from .shared import AssetClass, DataType
2+
from .common import AssetClass, DataType
33
from dataclasses import dataclass
44

55

‎polygon/rest/models/dividends.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from typing import Optional
2-
from .shared import DividendType, Frequency
2+
from .common import DividendType, Frequency
33
from dataclasses import dataclass
44

55

‎polygon/rest/models/exchanges.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from typing import Optional
2-
from .shared import AssetClass, Locale, ExchangeType
2+
from .common import AssetClass, Locale, ExchangeType
33
from dataclasses import dataclass
44

55

‎polygon/rest/models/tickers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from typing import Optional, List
2-
from .shared import Locale, Market, AssetClass
2+
from .common import Locale, Market, AssetClass
33
from dataclasses import dataclass
44

55

0 commit comments

Comments
 (0)