Skip to content
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

Document how to plot figures in generated docs from docstrings #20052

Closed
dukebody opened this issue Mar 8, 2018 · 2 comments
Closed

Document how to plot figures in generated docs from docstrings #20052

dukebody opened this issue Mar 8, 2018 · 2 comments
Labels
Milestone

Comments

@dukebody
Copy link
Contributor

dukebody commented Mar 8, 2018

Follow up for #20015. We need to write documentation about how to do this using blocks like:

..plot:: 
    :context: close-figs
    >>> s = pd.Series([1, 3, 2])
    >>> s.plot.line()

Should this be part of https://pandas.pydata.org/pandas-docs/stable/contributing.html#contributing-to-the-documentation? Are we planning to move the contents of https://python-sprints.github.io/pandas/guide/pandas_docstring.html there in a close future?

@jorisvandenbossche
Copy link
Member

@datapythonista added a basic explanation in https://python-sprints.github.io/pandas/guide/pandas_docstring.html#plots-in-examples. Can you have a look at that? Feel free to do a PR to improve the explanation (I already spotted an indentation error).

Are we planning to move the contents of https://python-sprints.github.io/pandas/guide/pandas_docstring.html there in a close future?

Yes, this is #19704. So idea is indeed that the sprint guide gets integrated in the pandas docs.

@jorisvandenbossche
Copy link
Member

I am going to close this issue, as the short explanation already has been added to the PR as well (#19704)

@jorisvandenbossche jorisvandenbossche added this to the 0.23.0 milestone Mar 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants