Skip to content

docs: Fix API Docs rendering #219

Merged
sbillinge merged 3 commits intodiffpy:mainfrom
cadenmyers13:docs-render
Mar 4, 2026
Merged

docs: Fix API Docs rendering #219
sbillinge merged 3 commits intodiffpy:mainfrom
cadenmyers13:docs-render

Conversation

@cadenmyers13
Copy link
Contributor

No description provided.

@cadenmyers13
Copy link
Contributor Author

cadenmyers13 commented Mar 3, 2026

@sbillinge Before rc release check this please.

I was having problems with API docs rendering and mocking utils seemed to fix it. Im not too sure exactly if we need to do that or have it in docs.txt. Do you know?

edit: removed it from docs.txt, dont think thats right. It seems that rendering these docs locally can be a bit buggy

@codecov
Copy link

codecov bot commented Mar 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.13%. Comparing base (24c43cb) to head (a01de7e).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #219   +/-   ##
=======================================
  Coverage   99.13%   99.13%           
=======================================
  Files           5        5           
  Lines         345      345           
=======================================
  Hits          342      342           
  Misses          3        3           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@sbillinge sbillinge merged commit 1aede7d into diffpy:main Mar 4, 2026
7 checks passed
@sbillinge
Copy link
Contributor

ok, the api docs didn't build before, so I merged this and will try again. Do we know why we need the diffpy.utils in the docs.txt?

@cadenmyers13 cadenmyers13 deleted the docs-render branch March 4, 2026 03:40
@cadenmyers13
Copy link
Contributor Author

@sbillinge We don't and thats why i removed it. Looks like the docs built this time

@sbillinge
Copy link
Contributor

I was looking at an outdated version. I see that it is gone now.

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