Skip to content

Add api docs#74

Open
hannahbaumann wants to merge 9 commits intomainfrom
api_docs
Open

Add api docs#74
hannahbaumann wants to merge 9 commits intomainfrom
api_docs

Conversation

@hannahbaumann
Copy link
Contributor

No description provided.

@codecov
Copy link

codecov bot commented Jan 29, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.19%. Comparing base (5260e3b) to head (ece3d15).
⚠️ Report is 8 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #74      +/-   ##
==========================================
+ Coverage   88.16%   89.19%   +1.03%     
==========================================
  Files           7        6       -1     
  Lines         338      324      -14     
==========================================
- Hits          298      289       -9     
+ Misses         40       35       -5     

☔ View full report in Codecov by Sentry.
📢 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.

@hannahbaumann hannahbaumann self-assigned this Feb 3, 2026
@hannahbaumann
Copy link
Contributor Author

pre-commit.ci autofix

@IAlibay IAlibay requested a review from jthorton February 10, 2026 13:37
Copy link
Member

@IAlibay IAlibay left a comment

Choose a reason for hiding this comment

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

Very quick drive-by review.

Copy link
Member

Choose a reason for hiding this comment

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

What is this flowchart for?

Copy link
Member

Choose a reason for hiding this comment

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

All these don't seem to be used anywhere, why add them?

Copy link
Member

Choose a reason for hiding this comment

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

Are these here because they are needed or because openfe has them?

Copy link
Member

Choose a reason for hiding this comment

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

Are these actually generated files? If not, to avoid confusion, I would say just add the rst files as-is under the api folder alongside the index.

If they are auto-generated, then it's not immediately clear to me that they should be commited.

#
html_theme = "ofe_sphinx_theme"
html_theme_options = {
"logo": {"text": "OpenFE docs"},
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"logo": {"text": "OpenFE docs"},
"logo": {"text": "openfe-analysis docs"},

sass_src_dir = "_sass"
sass_out_dir = "_static/css"

# Clone or update ExampleNotebooks
Copy link
Member

Choose a reason for hiding this comment

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

You don't need this here.

Copy link
Member

Choose a reason for hiding this comment

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

remove?


The **OpenFE Analysis** toolkit provides a free and open-source framework for analyzing alchemical free energy calculations.

.. grid:: 1 2 2 4
Copy link
Member

Choose a reason for hiding this comment

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

Do you plan on populating the full grid? Otherwise I would not go for this and just have an API title entry.

The openfe layout is a bit much for most sub-projects. Maybe see how Kartograf or gufe are set up?

If only a ligand:
If only a ligand is present:
- prevents the ligand from jumping between periodic images
- Aligns the ligand to minimize its RMSD
Copy link
Member

Choose a reason for hiding this comment

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

make capitalization consistent in these bullet points?

[![Logo](https://img.shields.io/badge/OSMF-OpenFreeEnergy-%23002f4a)](https://openfree.energy/)
[![CI](https://github.com/OpenFreeEnergy/openfe_analysis/actions/workflows/ci.yaml/badge.svg)](https://github.com/OpenFreeEnergy/openfe_analysis/actions/workflows/ci.yaml)
[![Coverage](https://codecov.io/gh/OpenFreeEnergy/openfe_analysis/graph/badge.svg?token=krb231ftki)](https://codecov.io/gh/OpenFreeEnergy/openfe_analysis)
[![documentation](https://readthedocs.org/projects/openfe/badge/?version=stable)](https://docs.openfree.energy/en/stable/?badge=stable)
Copy link
Member

Choose a reason for hiding this comment

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

wrong badge?

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