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

Fix documentation #487

Merged
merged 1 commit into from
Mar 8, 2024
Merged

Fix documentation #487

merged 1 commit into from
Mar 8, 2024

Conversation

timmens
Copy link
Member

@timmens timmens commented Mar 8, 2024

In this PR, we fix the API section of the documentation.

What happened?

In our documentation, we use mock imports. From the sphinx docs:

This is useful when some external dependencies are not met at build time and break the building process. You may only specify the root package of the dependencies themselves and omit the sub-modules:

However, mocked modules cannot be used during build time. This was not a problem until a few weeks ago when plotly started checking pandas version numbers (mocked for our documentation), which requires the execution of pandas code --- namely pandas.__version__ --- during build time. My unawareness of what was actually happening led me to restrict the plotly version (see #480).

In #482, I added code to estimagic that also checked the pandas version numbers, leading to the same problem as before.

Fix

Remove pandas from the list of mock imports.

Copy link

codecov bot commented Mar 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.98%. Comparing base (656319d) to head (f77fa22).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #487   +/-   ##
=======================================
  Coverage   92.98%   92.98%           
=======================================
  Files         194      194           
  Lines       14649    14649           
=======================================
  Hits        13621    13621           
  Misses       1028     1028           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@timmens timmens requested a review from hmgaudecker March 8, 2024 15:48
Copy link
Member

@hmgaudecker hmgaudecker left a comment

Choose a reason for hiding this comment

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

Helpful write-up of what happened!

@timmens timmens merged commit eb8dea7 into main Mar 8, 2024
17 checks passed
@timmens timmens deleted the fix-docs branch March 8, 2024 16:18
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