Skip to content

Commit 1ec2c22

Browse files
committed
Update doc
1 parent 9ca9565 commit 1ec2c22

14 files changed

+36
-32
lines changed

docs/group.rst

+8-4
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,26 @@ Overview
77
=============
88

99
.. automodule:: finvizfinance.group.overview
10-
:members:
10+
:show-inheritance:
11+
:inherited-members:
1112

1213
Valuation
1314
=============
1415

1516
.. automodule:: finvizfinance.group.valuation
16-
:members:
17+
:show-inheritance:
18+
:inherited-members:
1719

1820
Performance
1921
=============
2022

2123
.. automodule:: finvizfinance.group.performance
22-
:members:
24+
:show-inheritance:
25+
:inherited-members:
2326

2427
Spectrum
2528
=============
2629

2730
.. automodule:: finvizfinance.group.spectrum
28-
:members:
31+
:show-inheritance:
32+
:inherited-members:

docs/screener.rst

+14-7
Original file line numberDiff line numberDiff line change
@@ -7,40 +7,47 @@ Overview
77
=============
88

99
.. automodule:: finvizfinance.screener.overview
10-
:members:
10+
:show-inheritance:
11+
:inherited-members:
1112

1213
Valuation
1314
=============
1415

1516
.. automodule:: finvizfinance.screener.valuation
16-
:members:
17+
:show-inheritance:
18+
:inherited-members:
1719

1820
Financial
1921
=============
2022

2123
.. automodule:: finvizfinance.screener.financial
22-
:members:
24+
:show-inheritance:
25+
:inherited-members:
2326

2427
Ownership
2528
=============
2629

2730
.. automodule:: finvizfinance.screener.ownership
28-
:members:
31+
:show-inheritance:
32+
:inherited-members:
2933

3034
Technical
3135
=============
3236

3337
.. automodule:: finvizfinance.screener.technical
34-
:members:
38+
:show-inheritance:
39+
:inherited-members:
3540

3641
Custom
3742
=============
3843

3944
.. automodule:: finvizfinance.screener.custom
40-
:members:
45+
:show-inheritance:
46+
:inherited-members:
4147

4248
Tickers
4349
=============
4450

4551
.. automodule:: finvizfinance.screener.ticker
46-
:members:
52+
:show-inheritance:
53+
:inherited-members:

finvizfinance/group/custom.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010
class Custom(Base):
11-
"""Custom inherit from overview module.
11+
"""Custom
1212
Getting information from the finviz group custom page.
1313
"""
1414

finvizfinance/group/performance.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010
class Performance(Base):
11-
"""Performance inherit from overview module.
11+
"""Performance
1212
Getting information from the finviz group performance page.
1313
"""
1414

finvizfinance/group/spectrum.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111

1212
class Spectrum(Base):
13-
"""Spectrum inherit from overview module.
13+
"""Spectrum
1414
Getting information from the finviz group spectrum page.
1515
"""
1616

finvizfinance/group/valuation.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010
class Valuation(Base):
11-
"""Valuation inherit from overview module.
11+
"""Valuation
1212
Getting information from the finviz group valuation page.
1313
"""
1414

finvizfinance/screener/custom.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88

99

1010
class Custom(Base):
11-
"""Custom inherit from overview module.
11+
"""Custom
1212
Getting information from the finviz screener custom page.
1313
"""
14-
1514
v_page = 151
1615

1716
def screener_view(

finvizfinance/screener/financial.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99

1010
class Financial(Base):
11-
"""Financial inherit from overview module.
11+
"""Financial
1212
Getting information from the finviz screener financial page.
1313
"""
14-
1514
v_page = 161

finvizfinance/screener/ownership.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99

1010

1111
class Ownership(Base):
12-
"""Ownership inherit from overview module.
12+
"""Ownership
1313
Getting information from the finviz screener ownership page.
1414
"""
15-
1615
v_page = 131

finvizfinance/screener/performance.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99

1010

1111
class Performance(Base):
12-
"""Performance inherit from overview module.
12+
"""Performance
1313
Getting information from the finviz screener performance page.
1414
"""
15-
1615
v_page = 141

finvizfinance/screener/technical.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@
99

1010

1111
class Technical(Base):
12-
"""Technical inherit from overview module.
12+
"""Technical
1313
Getting information from the finviz screener technical page.
1414
"""
15-
1615
v_page = 171

finvizfinance/screener/ticker.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@
1515

1616

1717
class Ticker(Base):
18-
"""Financial inherit from overview module.
18+
"""Financial
1919
Getting information from the finviz screener ticker page.
2020
"""
21-
2221
v_page = 411
2322

2423
def _screener_helper(self, i, page, soup, tickers, limit):

finvizfinance/screener/valuation.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88

99

1010
class Valuation(Base):
11-
"""Valuation inherit from overview module.
11+
"""Valuation
1212
Getting information from the finviz screener valuation page.
1313
"""
14-
1514
v_page = 121

requirements-doc.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
-r requirements.txt
22

33
# doc
4-
Sphinx==2.2.1
5-
sphinx-rtd-theme==0.4.3
6-
docutils==0.17.1
4+
Sphinx==7.2.6
5+
sphinx-rtd-theme==2.0.0
6+
docutils==0.20.1

0 commit comments

Comments
 (0)