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

DOC: styler warnings in doc-build #16033

Closed
jreback opened this issue Apr 17, 2017 · 6 comments · Fixed by #16094
Closed

DOC: styler warnings in doc-build #16033

jreback opened this issue Apr 17, 2017 · 6 comments · Fixed by #16094
Labels

Comments

@jreback
Copy link
Contributor

jreback commented Apr 17, 2017

https://travis-ci.org/pandas-dev/pandas/jobs/222779268

/tmp/doc/source/generated/pandas.io.formats.style.Styler.rst:74: WARNING: failed to import template:
/tmp/doc/source/generated/pandas.io.formats.style.Styler.rst:74: WARNING: toctree references unknown document 'generated/template:'

cc @TomAugspurger @jorisvandenbossche

I just pushed a change to fix the path of the imports (after pandas.formats change), but I think it still needs something.

@jreback jreback added the Docs label Apr 17, 2017
@jreback jreback added this to the 0.20.0 milestone Apr 17, 2017
@TomAugspurger
Copy link
Contributor

Yeah saw that. I'll clean up the warnings in the doc build today.

@TomAugspurger
Copy link
Contributor

For this specific one, it seems like it tries to auto-doc all of these

    Attributes
    ----------
    env : Jinja2 Environment
    template: Jinja2 Template
    loader : Jinja2 Loader

but template isn't a python module. I'll see if there's an easy way to skip just one.

@TomAugspurger
Copy link
Contributor

For reference, there's the :exclude-members: template directive that might have worked. It's supposed to work with autodoc, but I haven't found anything about whether it works with autosummary. numpy/numpydoc#69 might be involved

I've turned those attributes into properties with their own docstings, and the warning is fixed.

I'll bush a batch of doc fixes a bit later today.

jreback added a commit to jreback/pandas that referenced this issue Apr 22, 2017
jreback added a commit to jreback/pandas that referenced this issue Apr 22, 2017
jreback added a commit that referenced this issue Apr 22, 2017
@jreback
Copy link
Contributor Author

jreback commented Apr 22, 2017

FYI @TomAugspurger this was just an incorrect usage of pytest.warn rather than tm.assert_produces_warning

@jreback jreback reopened this Apr 22, 2017
@jreback
Copy link
Contributor Author

jreback commented Apr 22, 2017

sorry @TomAugspurger wrong issue.

@jreback jreback modified the milestones: Next Major Release, 0.20.0 Apr 22, 2017
pcluo pushed a commit to pcluo/pandas that referenced this issue May 22, 2017
@jorisvandenbossche
Copy link
Member

I don't see those anymore in the doc build output on travis: https://travis-ci.org/pandas-dev/pandas/jobs/349024108, so closing

@jorisvandenbossche jorisvandenbossche modified the milestones: Next Major Release, No action Mar 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants