Skip to content

DOC: Adding missing module, causing sphinx not to find functions/methods #24420

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 1 commit into from
Dec 25, 2018
Merged

DOC: Adding missing module, causing sphinx not to find functions/methods #24420

merged 1 commit into from
Dec 25, 2018

Conversation

datapythonista
Copy link
Member

@datapythonista datapythonista commented Dec 25, 2018

sphinx is generating warnings because we reference API pages that don't exist.

This is because autosummary is processed before the currentmodule directive is injected to {{ header }}

Copy link
Contributor

@jreback jreback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are you removing these??? it doesn’t matter if we don’t reference these from the docs themselves, these r all valid

@codecov
Copy link

codecov bot commented Dec 25, 2018

Codecov Report

Merging #24420 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24420   +/-   ##
=======================================
  Coverage    92.3%    92.3%           
=======================================
  Files         163      163           
  Lines       51950    51950           
=======================================
  Hits        47953    47953           
  Misses       3997     3997
Flag Coverage Δ
#multiple 90.71% <ø> (ø) ⬆️
#single 43% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 159772d...9160722. Read the comment docs.

@codecov
Copy link

codecov bot commented Dec 25, 2018

Codecov Report

Merging #24420 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #24420   +/-   ##
=======================================
  Coverage    92.3%    92.3%           
=======================================
  Files         163      163           
  Lines       51950    51950           
=======================================
  Hits        47953    47953           
  Misses       3997     3997
Flag Coverage Δ
#multiple 90.71% <ø> (ø) ⬆️
#single 43% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 159772d...4d3f527. Read the comment docs.

@datapythonista datapythonista changed the title DOC: Removing functions/methods in the docs that do not exist in the code DOC: Adding missing module, causing sphinx not to find functions/methods Dec 25, 2018
@datapythonista
Copy link
Member Author

Sorry, my fault, had a problem in my pandas set up, and I was getting sphinx warnings that weren't true, about those methods/functions not existing. Just couple of the were real, because of the module being missing.

@jreback jreback added this to the 0.24.0 milestone Dec 25, 2018
@jreback jreback merged commit befd324 into pandas-dev:master Dec 25, 2018
@jreback
Copy link
Contributor

jreback commented Dec 25, 2018

thanks @datapythonista

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants