Skip to content

DOC: start documentation for pandas-datareader #18

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.

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 4 commits into from
Mar 28, 2015

Conversation

jorisvandenbossche
Copy link
Member

I just did a sphinx-quickstart, added the current remote_data.rst file from pandas, and adapted this a little bit.

Further to do:

  • Add reference docs (docstrings)
  • set up read the docs

@femtotrader
Copy link
Contributor

it will be nice if doc for pandas-datareader could be available on readthedocs https://readthedocs.org/

@jorisvandenbossche
Copy link
Member Author

@femtotrader yes, certainly! I put that as a to do item above

@femtotrader
Copy link
Contributor

One file per datareader is probably a way to go (for doc but probably for code too).

It will become much easier to add new datareader this way.

@jorisvandenbossche
Copy link
Member Author

I am going the merge this, to be able to test it with read the docs

jorisvandenbossche added a commit that referenced this pull request Mar 28, 2015
DOC: start documentation for pandas-datareader
@jorisvandenbossche jorisvandenbossche merged commit 3f8b6b1 into pydata:master Mar 28, 2015
@jorisvandenbossche
Copy link
Member Author

The current docs are up here: http://pandas-datareader.readthedocs.org/en/latest/index.html

@jorisvandenbossche
Copy link
Member Author

@dstephens99 For the docs, do you have a readthedocs.org account? (you can login with a github account) Then I can maybe add you as maintainer, so I am not the only one with access to the doc build.

@femtotrader
Copy link
Contributor

Could you add a badge for doc to README.rst ?
see http://docs.readthedocs.org/en/latest/badges.html
and https://readthedocs.org/projects/pandas-datareader/

reStructuredText

.. image:: https://readthedocs.org/projects/pandas-datareader/badge/?version=latest
:target: https://readthedocs.org/projects/pandas-datareader/?badge=latest
:alt: Documentation Status

Markdown

[![Documentation Status](https://readthedocs.org/projects/pandas-datareader/badge/?version=latest)](https://readthedocs.org/projects/pandas-datareader/?badge=latest)

HTML

<a href='https://readthedocs.org/projects/pandas-datareader/?badge=latest'>
    <img src='https://readthedocs.org/projects/pandas-datareader/badge/?version=latest' alt='Documentation Status' />
</a>

It will be easier to find doc from GitHub repository.

@jorisvandenbossche
Copy link
Member Author

@femtotrader voila: #42

@jorisvandenbossche
Copy link
Member Author

@femtotrader Thanks for the idea!

@femtotrader
Copy link
Contributor

Merci Monsieur.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants