Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix docs builds #319

Merged
merged 5 commits into from
Feb 11, 2025
Merged

Fix docs builds #319

merged 5 commits into from
Feb 11, 2025

Conversation

mattwthompson
Copy link
Member

@mattwthompson mattwthompson commented Feb 4, 2025

Description

Partially resolves #318

Todos

Notable points that this PR has either accomplished or will accomplish.

  • Explicitly indicate docs configuration file
  • Resolve docs build errors

Status

  • Ready to go

.readthedocs.yml Outdated
Comment on lines 8 to 11
sphinx:
configuration: docs/conf.py
fail_on_warning: true

Copy link
Member Author

Choose a reason for hiding this comment

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

@mattwthompson mattwthompson marked this pull request as ready for review February 10, 2025 20:45
Copy link
Member

@j-wags j-wags left a comment

Choose a reason for hiding this comment

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

Thanks @mattwthompson!

@j-wags
Copy link
Member

j-wags commented Feb 11, 2025

Oh, I see the docs builds are hitting some other errors. Well this is still a clear improvement to me. This can be merged as-is, and I've updated the description to clarify that it's a partial resolution, and I'll leave #318 open and in current iteration on zenhub.

Copy link

codecov bot commented Feb 11, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.63%. Comparing base (c298486) to head (ddad3aa).
Report is 1 commits behind head on main.

Additional details and impacted files

@mattwthompson
Copy link
Member Author

This surfaced several long-standing, not all of which I am able to resolve in an hour and half or so of work:

See remaining warnings: https://app.readthedocs.org/projects/openff-qcsubmit/builds/27150302/

I think these should be dealt with later since this still fixes the original issue (that docs were not building at all) and just adds in more fixes for free

@mattwthompson mattwthompson merged commit 637c823 into main Feb 11, 2025
8 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.

Docs not building
2 participants