Skip to content

Fix README example link#82

Merged
orbeckst merged 3 commits into
Becksteinlab:mainfrom
Mirochill:docs-79-readme-examples-link
Jun 26, 2026
Merged

Fix README example link#82
orbeckst merged 3 commits into
Becksteinlab:mainfrom
Mirochill:docs-79-readme-examples-link

Conversation

@Mirochill

@Mirochill Mirochill commented May 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace the removed notebook/nbviewer README link with the published example usage page
  • keep the README pointing at the current documentation for PropkaTraj examples

Closes #79

Validation

  • git diff --check
  • Confirmed https://becksteinlab.github.io/propkatraj/usage/examples.html returns HTTP 200
  • Not run locally (README-only change)

Remote status

  • Read the Docs build 32841694 currently fails while evaluating docs/sphinx/conf.py, because propka==3.1.0 imports pkg_resources under the Python 3.14 docs environment. This happens before the README link change is exercised.

@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.30%. Comparing base (23ca6de) to head (f6524f2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #82   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files           2        2           
  Lines          59       59           
=======================================
  Hits           58       58           
  Misses          1        1           

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

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

@orbeckst orbeckst marked this pull request as ready for review June 26, 2026 05:31

@orbeckst orbeckst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for the fix!

@orbeckst orbeckst merged commit 31e1396 into Becksteinlab:main Jun 26, 2026
22 checks passed
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.

Jupyter notebook link broken in README.md

2 participants