diff --git a/docs/source/conf.py b/docs/source/conf.py index e2eb9738..69c882f1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -12,6 +12,8 @@ # # All configuration values have a default; values that are commented out # serve to show the default. +import datetime as dt + import pandas_datareader as pdr # Add any Sphinx extension module names here, as strings. They can be @@ -57,8 +59,8 @@ master_doc = "index" # General information about the project. -project = u"pandas-datareader" -copyright = u"2020, The PyData Development Team" +project = "pandas-datareader" +copyright = "2020, The PyData Development Team" author = "The PyData Development Team" # The version info for the project you're documenting, acts as replacement for @@ -76,6 +78,11 @@ # The full version, including alpha/beta/rc tags. release = pdr.__version__ +# Write version and build date +with open("_version.txt", "w") as version_file: + doc_date = dt.datetime.now().strftime("%B %-d, %Y") + version_file.write(f"Version: **{version}** Date: **{doc_date}**\n") + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # diff --git a/docs/source/index.rst b/docs/source/index.rst index 19df7a68..4e454f33 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,10 +3,35 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -.. include:: ../../README.rst -Documentation -------------- +pandas-datareader +================= + +.. include:: _version.txt + +Up to date remote data access for pandas, works for multiple versions of pandas. + + +Quick Start +----------- + +Install using ``pip`` + +.. code-block:: shell + + pip install pandas-datareader + +and then import and use one of the data readers. This example reads 5-years +of 10-year constant maturity yields on U.S. government bonds. + +.. code-block:: python + + import pandas_datareader as pdr + pdr.get_data_fred('GS10') + + +Contents +-------- Contents: @@ -19,10 +44,36 @@ Contents: readers/index whatsnew.rst +Documentation +------------- + +`Stable documentation `__ +is available on +`github.io `__. +A second copy of the stable documentation is hosted on +`read the docs `_ for more details. + +Recent developments +------------------- +You can install the latest development version using + +.. code-block:: shell + + pip install git+https://github.com/pydata/pandas-datareader.git + +or + +.. code-block:: shell + + git clone https://github.com/pydata/pandas-datareader.git + cd pandas-datareader + python setup.py install +`Development documentation `__ +is available for the latest changes in master. Indices and tables -================== +------------------ * :ref:`genindex` * :ref:`modindex`