Skip to content

Add Enums to docs #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Darcy-Linde merged 7 commits into from
May 5, 2022
Merged

Add Enums to docs #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
accb04c
changed shared to common
May 5, 2022
2c46c89
add common.rst
May 5, 2022
c7657da
remove common.rst
May 5, 2022
d9b772e
enum.rst
May 5, 2022
2001aa8
sphinx doc commands
May 5, 2022
c11d0cb
add header to enum.rst
May 5, 2022
f41db89
add missing members call
May 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions docs/source/Enums.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:

3 changes: 0 additions & 3 deletions docs/source/Models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,3 @@ Condition
Exchange
==============================================================
.. autoclass:: polygon.rest.models.Exchange



1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ This documentation is for the Python client only. For details about the response
Trades
vX
Models
Enums


Indices and tables
Expand Down
2 changes: 1 addition & 1 deletion polygon/rest/models/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from .shared import *
from .common import *
from .aggs import *
from .trades import *
from .quotes import *
Expand Down
0 polygon/rest/models/shared.py → polygon/rest/models/common.py
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion polygon/rest/models/conditions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from typing import Optional
from .shared import AssetClass, DataType
from .common import AssetClass, DataType
from dataclasses import dataclass


Expand Down
2 changes: 1 addition & 1 deletion polygon/rest/models/dividends.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from typing import Optional
from .shared import DividendType, Frequency
from .common import DividendType, Frequency
from dataclasses import dataclass


Expand Down
2 changes: 1 addition & 1 deletion polygon/rest/models/exchanges.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
from typing import Optional
from .shared import AssetClass, Locale, ExchangeType
from .common import AssetClass, Locale, ExchangeType
from dataclasses import dataclass


Expand Down
2 changes: 1 addition & 1 deletion polygon/rest/models/tickers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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


Expand Down