Skip to content

DOC: Restructure docs #803

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
merged 1 commit into from
Jul 7, 2020
Merged

DOC: Restructure docs #803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
33 changes: 11 additions & 22 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,17 @@ Up to date remote data access for pandas, works for multiple versions of pandas.
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black

Installation
------------

Usage
-----

Starting in 0.19.0, pandas no longer supports ``pandas.io.data`` or ``pandas.io.wb``, so
you must replace your imports from ``pandas.io`` with those from ``pandas_datareader``:
Install using ``pip``

.. code-block:: python
.. code-block:: shell

from pandas.io import data, wb # becomes
from pandas_datareader import data, wb
pip install pandas-datareader

Many functions from the data module have been included in the top level API.
Usage
-----

.. code-block:: python

Expand All @@ -52,9 +50,6 @@ A second copy of the stable documentation is hosted on
`Development documentation <https://pydata.github.io/pandas-datareader/devel/>`__
is available for the latest changes in master.

Installation
------------

Requirements
~~~~~~~~~~~~

Expand Down Expand Up @@ -83,23 +78,17 @@ Development and testing additionally requires:
* pytest-cov
* wrapt

Install latest release version via pip
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: shell

$ pip install pandas-datareader

Install latest development version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: shell

$ pip install git+https://github.com/pydata/pandas-datareader.git
pip install git+https://github.com/pydata/pandas-datareader.git

or

.. code-block:: shell

$ git clone https://github.com/pydata/pandas-datareader.git
$ python setup.py install
git clone https://github.com/pydata/pandas-datareader.git
cd pandas-datareader
python setup.py install
6 changes: 3 additions & 3 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@

.. include:: ../../README.rst


Documentation
-------------

Contents:

.. toctree::
:maxdepth: 2
:maxdepth: 1

whatsnew.rst
remote_data.rst
cache.rst
see-also.rst
readers/index
whatsnew.rst



Indices and tables
Expand Down