FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

fix: fix documentation rendered properly by stevenhua0320 · Pull Request #192 · diffpy/diffpy.structure · GitHub

  1. diffpy
  2. diffpy.structure

Repository navigation

fix: fix documentation rendered properly - #192

Merged
sbillinge merged 1 commit into
diffpy:mainfrom
stevenhua0320:documentation-fix
Mar 29, 2026
ConversationCommits (1)ChecksFiles changed
Merged

fix: fix documentation rendered properly#192
sbillinge merged 1 commit into
diffpy:mainfrom
stevenhua0320:documentation-fix

Conversation

stevenhua0320 commented Mar 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

@sbillinge ready to review. In this PR:

  1. Fix documentation issues for diffpy.structure. This issue arises because as we add diffpy.utils as the dependencies for deprecator, when rendering the documentation, it couldn't find it internally and fails to render all classes that have deprecators. So, I made a mock-imports since the original documentation is not affected.
  2. As we added a new parser p-vesta, when I run the package build api-doc, it auto-added all the new apis. I took a review for them and they are right.
    The new local documentation is shown below. I think they are rendering properly after this edit.

codecov Bot commented Mar 29, 2026 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.20%. Comparing base (41c51ac) to head (87f8b12).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #192   +/-   ##
=======================================
  Coverage   99.20%   99.20%           
=======================================
  Files          15       15           
  Lines        2507     2507           
=======================================
  Hits         2487     2487           
  Misses         20       20
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

stevenhua0320 mentioned this pull request Mar 29, 2026
Closed
20 tasks done
sbillinge merged commit 7b25422 into diffpy:main Mar 29, 2026
7 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL