Skip to content

Commit 20224f4

Browse files
committed
DOC: Finalize documentation for 0.6.0 release
Final changes to documentation
1 parent f9f778d commit 20224f4

File tree

9 files changed

+54
-16
lines changed

9 files changed

+54
-16
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ after_success:
8585
if [[ -z ${TRAVIS_TAG} ]]; then
8686
echo "Not a tagged build."
8787
else
88-
doctr deploy doc --build-tags
88+
doctr deploy stable --build-tags
8989
fi
9090
fi
9191
- coveralls

README.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,5 +77,9 @@ Many functions from the data module have been included in the top level API.
7777
Documentation
7878
-------------
7979

80-
See the `pandas-datareader documentation <https://pandas-datareader.readthedocs.io/>`_
81-
for more details.
80+
`Stable documentation <https://pydata.github.io/pandas-datareader/stable/>`__
81+
is available at . A second copy of the stable documentation is hosted on
82+
`read the docs <https://pandas-datareader.readthedocs.io/>`_ for more details.
83+
84+
`Development documentation <https://pydata.github.io/pandas-datareader/devel/>`__
85+
is available for the latest changes in master.

docs/source/readers/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Data Readers
1111
eurostat
1212
iex
1313
moex
14+
morningstar
1415
nasdaq-trader
1516
oecd
1617
quandl

docs/source/readers/morningstar.rst

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,3 @@ Morningstar
66
.. autoclass:: MorningstarDailyReader
77
:members:
88
:inherited-members:
9-
10-
.. py:module:: pandas_datareader.mstar.financials
11-
12-
.. autoclass:: MorningstarDailyReader
13-
:members:
14-
:inherited-members:

docs/source/remote_data.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ extract data from various Internet sources into a pandas DataFrame.
2929
Currently the following sources are supported:
3030

3131
- :ref:`Google Finance<remote_data.google>`
32+
- :ref:`Morningstar<remote_data.morningstar>`
3233
- :ref:`IEX<remote_data.iex>`
3334
- :ref:`Enigma<remote_data.enigma>`
3435
- :ref:`Quandl<remote_data.quandl>`
@@ -64,6 +65,22 @@ Google Finance
6465
f = web.DataReader('F', 'google', start, end)
6566
f.ix['2010-01-04']
6667
68+
.. _remote_data.morningstar:
69+
70+
Morningstar
71+
===========
72+
OHLC and Volume data is available from Morningstar using the same API which
73+
powers their charts.
74+
75+
.. ipython:: python
76+
77+
import pandas_datareader.data as web
78+
from datetime import datetime
79+
start = datetime(2015, 2, 9)
80+
end = datetime(2017, 5, 24)
81+
f = web.DataReader('F', 'morningstar', start, end)
82+
f.head()
83+
6784
.. _remote_data.iex:
6885

6986
IEX

docs/source/whatsnew/v0.6.0.txt

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,24 @@ Highlights include:
4747
Enhancements
4848
~~~~~~~~~~~~
4949

50-
- A new data connector for stock index data provided by Stooq was
51-
introduced. (:issue:`447`)
5250

53-
- A new data connector for data provided by the Bank of Canada was
54-
introduced. (:issue:`440`)
51+
- A new data connector for data provided by the
52+
`Bank of Canada <https://www.bankofcanada.ca/rates/>`__ was introduced.
53+
(:issue:`440`)
54+
55+
- A new data connector for stock index data provided by
56+
`Stooq <https://stooq.com>`__ was introduced. (:issue:`447`)
57+
58+
- A new connector for IEX the majority of the
59+
`IEX API <https://iextrading.com/developer/docs/>`__ was introduced
60+
(:issue:`446`).
61+
62+
- A new connector for
63+
`IEX daily price data <https://iextrading.com/developer/docs/>`__ was
64+
introduced (:issue:`465`).
5565

56-
- A new data connector for stock pricing data provided by Morningstar
57-
was introduced. (:issue:`467`)
66+
- A new data connector for stock pricing data provided by
67+
`Morningstar <http://www.morningstar.com>`__ was introduced. (:issue:`467`)
5868

5969
.. _whatsnew_060.api_breaking:
6070

pandas_datareader/bankofcanada.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@
66

77

88
class BankOfCanadaReader(_BaseReader):
9-
"""Get data for the given name from Bank of Canada."""
9+
"""Get data for the given name from Bank of Canada.
10+
11+
Notes
12+
-----
13+
See `Bank of Canada <https://www.bankofcanada.ca/rates/>`__"""
1014

1115
_URL = 'http://www.bankofcanada.ca/valet/observations'
1216

pandas_datareader/mstar/daily.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ class MorningstarDailyReader(_BaseReader):
4040
Currency to use for data
4141
interval : str, optional
4242
Sampling interval to use for downloaded data
43+
44+
Notes
45+
-----
46+
See `Morningstar <http://www.morningstar.com>`__
4347
"""
4448

4549
def __init__(self, symbols, start=None, end=None, retry_count=3,

pandas_datareader/stooq.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ class StooqDailyReader(_DailyBaseReader):
2222
Number of symbols to download consecutively before intiating pause.
2323
session : Session, default None
2424
requests.sessions.Session instance to be used
25+
26+
Notes
27+
-----
28+
See `Stooq <https://stooq.com>`__
2529
"""
2630

2731
@property

0 commit comments

Comments
 (0)