Skip to content

Conversation

@alisnwu
Copy link

@alisnwu alisnwu commented Nov 11, 2024

closes #137

@bobleesj could you check this PR before I ping Simon, closes the last issue in 3.5.1

@codecov
Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.17%. Comparing base (08917a2) to head (b1cc3c7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #167   +/-   ##
=======================================
  Coverage   99.17%   99.17%           
=======================================
  Files           7        7           
  Lines         243      243           
=======================================
  Hits          241      241           
  Misses          2        2           

@bobleesj
Copy link
Contributor

bobleesj commented Nov 11, 2024

@alisnwu Thanks! First, just to double check, are the modifications generated dynamically using the API workflow in the cookiecutter repo README instructions? If not, let's use that and please also attach a screenshot here to ensure that it works after you've done

cd doc && make html && open build/html/index.html && cd ..

For the example, have you followed the instructions that you've tried?

from pathlib import Path

autodoc_mock_imports = [
"diffpy.utils.wx",
Copy link
Contributor

@bobleesj bobleesj Nov 11, 2024

Choose a reason for hiding this comment

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

why was this added?

Copy link
Author

Choose a reason for hiding this comment

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

sphinx gave an error WARNING: autodoc: failed to import module 'gridutils' from module 'diffpy.utils.wx'; the following exception was raised: No module named 'wx' [autodoc.import_object]
So I followed the cookiecutter instructions for that error

@bobleesj
Copy link
Contributor

@alisnwu this PR isn't ready for review right? Please let us know since it's in my notification box. Please make this PR title is descriptive so that we get a sense of what is being worked on from the title alone. Please use the PR/commit guide provided earlier by me.

@alisnwu
Copy link
Author

alisnwu commented Nov 11, 2024

No sorry about that, I'll also close this and reopen after issues are fixed

@alisnwu alisnwu changed the title Documentation update Documentation update for resampler relocation and removed relative path imports Nov 11, 2024
@alisnwu alisnwu closed this Nov 11, 2024
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.

documentation for importing wsinterp from parsers error

2 participants