Skip to content

Generate complete Python and C++ API documentation with checked CI - #184

Merged
spraharsh merged 15 commits into
mainfrom
docs-autogeneration
Oct 12, 2026
Merged

spraharsh merged 15 commits into
mainfrom
docs-autogeneration

Conversation

@spraharsh

@spraharsh spraharsh commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

Get a working docs page that is nice to look at

Integrate core C++ interfaces with the complete Doxygen reference, verify
combined HTML links and API targets, and add installation navigation.
Fix the getting-started storage callback and keep publication disabled
until the owner approves the hosting and protection setup.
@spraharsh spraharsh changed the title Restore checked Sphinx documentation and integrate the C++ API Generate complete Python and C++ API documentation with checked CI Oct 12, 2026
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.44%. Comparing base (f208883) to head (419f06c).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #184      +/-   ##
==========================================
- Coverage   72.85%   71.44%   -1.42%     
==========================================
  Files         201      138      -63     
  Lines       16471     9833    -6638     
  Branches     1242     1242              
==========================================
- Hits        12000     7025    -4975     
+ Misses       4073     2413    -1660     
+ Partials      398      395       -3     
Flag Coverage Δ
cpp ?
python 71.44% <ø> (+0.11%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
pele/accept_tests/__init__.py 100.00% <ø> (ø)
pele/amber/read_amber.py 0.00% <ø> (ø)
pele/angleaxis/__init__.py 100.00% <ø> (ø)
pele/angleaxis/aamindist.py 75.36% <ø> (ø)
pele/angleaxis/rigidbody.py 78.45% <ø> (ø)
pele/basinhopping.py 72.22% <ø> (ø)
pele/distance/__init__.py 100.00% <ø> (ø)
pele/landscape/__init__.py 100.00% <ø> (ø)
pele/mc.py 65.00% <ø> (ø)
pele/mindist/minpermdist_stochastic.py 86.76% <ø> (ø)
... and 23 more

... and 63 files with indirect coverage changes


Continue to review full report in Codecov by Harness.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@spraharsh

Copy link
Copy Markdown
Member Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-12T01:33:21.407702Z 8493971 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Hooray!

Reviewed commit: 8493971531

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

spraharsh and others added 3 commits October 11, 2026 21:57
Replace the classic theme and scipy.css with Shibuya, keeping the curated
Python and C++ navigation as the left sidebar and fixing C++ base-class
signatures that the theme split onto their own line. Update the copyright
to the pele developers.

Restore the mtime of generated pages whose content is unchanged so an
incremental build only re-reads pages that actually changed. Use plain
pip in the install guides.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@spraharsh
spraharsh merged commit fd6d37c into main Oct 12, 2026
27 checks passed

This branch was successfully deployed

1 active deployment
github-pages — e21a5917 Deployed Oct 12, 2026 by spraharsh via Publish documentation #20
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