Skip to content

Commit 3c30089

Browse files
authored
Merge pull request #803 from bashtage/restructure-docs
DOC: Restructure docs
2 parents c4bba86 + 146f6b1 commit 3c30089

File tree

2 files changed

+14
-25
lines changed

2 files changed

+14
-25
lines changed

README.rst

+11-22
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,17 @@ Up to date remote data access for pandas, works for multiple versions of pandas.
2121
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
2222
:target: https://github.com/psf/black
2323

24+
Installation
25+
------------
2426

25-
Usage
26-
-----
27-
28-
Starting in 0.19.0, pandas no longer supports ``pandas.io.data`` or ``pandas.io.wb``, so
29-
you must replace your imports from ``pandas.io`` with those from ``pandas_datareader``:
27+
Install using ``pip``
3028

31-
.. code-block:: python
29+
.. code-block:: shell
3230
33-
from pandas.io import data, wb # becomes
34-
from pandas_datareader import data, wb
31+
pip install pandas-datareader
3532
36-
Many functions from the data module have been included in the top level API.
33+
Usage
34+
-----
3735

3836
.. code-block:: python
3937
@@ -52,9 +50,6 @@ A second copy of the stable documentation is hosted on
5250
`Development documentation <https://pydata.github.io/pandas-datareader/devel/>`__
5351
is available for the latest changes in master.
5452

55-
Installation
56-
------------
57-
5853
Requirements
5954
~~~~~~~~~~~~
6055

@@ -83,23 +78,17 @@ Development and testing additionally requires:
8378
* pytest-cov
8479
* wrapt
8580

86-
Install latest release version via pip
87-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88-
89-
.. code-block:: shell
90-
91-
$ pip install pandas-datareader
92-
9381
Install latest development version
9482
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9583

9684
.. code-block:: shell
9785
98-
$ pip install git+https://github.com/pydata/pandas-datareader.git
86+
pip install git+https://github.com/pydata/pandas-datareader.git
9987
10088
or
10189

10290
.. code-block:: shell
10391
104-
$ git clone https://github.com/pydata/pandas-datareader.git
105-
$ python setup.py install
92+
git clone https://github.com/pydata/pandas-datareader.git
93+
cd pandas-datareader
94+
python setup.py install

docs/source/index.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@
55
66
.. include:: ../../README.rst
77

8-
98
Documentation
109
-------------
1110

1211
Contents:
1312

1413
.. toctree::
15-
:maxdepth: 2
14+
:maxdepth: 1
1615

17-
whatsnew.rst
1816
remote_data.rst
1917
cache.rst
2018
see-also.rst
2119
readers/index
20+
whatsnew.rst
21+
2222

2323

2424
Indices and tables

0 commit comments

Comments
 (0)