Skip to content

DOC/BLD: attributes initialized as None not picked up by autosummary anymore #6100

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

Closed
jorisvandenbossche opened this issue Jan 25, 2014 · 11 comments
Labels

Comments

@jorisvandenbossche
Copy link
Member

I already mentioned it here: #5899 (comment), but then this did not appear on the dev doc builds on the website and only locally on my computer. But now I also see it there. See eg http://pandas.pydata.org/pandas-docs/dev/generated/pandas.DataFrame.html#pandas.DataFrame in the list of attributes, the is_copy is no link anymore.

So I get the following warning: DataFrame.is_copy.rst:: WARNING: document isn't included in any toctree for 8 methods:

pandas.DataFrame.is_copy
pandas.DatetimeIndex.name
pandas.DatetimeIndex.offset
pandas.Index.asi8
pandas.Index.name
pandas.Panel.is_copy
pandas.Panel4D.is_copy
pandas.Series.is_copy

Strange thing is, there have not been recent changes to these functions (I think), but the errors only appeared recently.
@y-p You did the most recent doc build on the website? (does this not happen automatically anymore?)

@ghost
Copy link

ghost commented Jan 25, 2014

yes I did and no it doesn't, we don't know why.

@ghost
Copy link

ghost commented Jan 25, 2014

@jorisvandenbossche, are you familiar with git bisect?

@jorisvandenbossche
Copy link
Member Author

Not yet, but I will try. At least first find a previous version that does not have this.

@ghost
Copy link

ghost commented Jan 31, 2014

I lookes at this a couple of days ago, the original commit where you introduced _templates
already had some of these warnings.

@jorisvandenbossche
Copy link
Member Author

Yes, I also tried to go back to locate the change, and noticed that even the released 0.13 and previous development versions of 0.12 have this issue If I checkout them now and run the docs. But the strange thing is, I only saw these warnings more recently in January, and never before. Also, for example the stable docs at the moment (from 0.13) don't have the issue (stable docs Series docstring), while the dev docs have (dev docs Series docstring).

So it seems that there is also something else apart from pandas that plays a role, but I shouldn't know what.

@jorisvandenbossche
Copy link
Member Author

Correction, it does appear also in the stable docs, just not for Series where I linked to above for some reason, but it does for DataFrame and Index etc. But I really thought it was not the case before (as I said in my comment #5899 (comment)).

BTW, the links to the docs of 0.12 and 0.11 on the main website are dead.

@ghost
Copy link

ghost commented Jan 31, 2014

That was not fun.

@jorisvandenbossche
Copy link
Member Author

And has become 'worse': http://pandas.pydata.org/pandas-docs/dev/generated/pandas.Index.html. I mean, previously it was only name and asi8 in Index which had this problem, now 6 attributes. While nothing changed to the code I think.

@jreback
Copy link
Contributor

jreback commented Feb 4, 2014

do you have any idea what the problem is?

@jreback
Copy link
Contributor

jreback commented May 1, 2014

@jorisvandenbossche any fix on this?

@jorisvandenbossche
Copy link
Member Author

Not yet. Should take some more time to investigate this, but it's no blocker for 0.14 I think (at least not for a first release candidate).

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