Skip to content

Conversation

@paulromano
Copy link
Contributor

Description

This PR fixes #3318 and fixes #3319. For #3318, I've added an error message telling the user how to resolve the problem. For #3319, I've added a configuration variable that tells RTD to get the full git history so that it can determine the version properly.

Checklist

  • I have performed a self-review of my own code
  • I have run clang-format (version 15) on any C++ source files (if applicable)
  • I have followed the style guidelines for Python source files (if applicable)
  • I have made corresponding changes to the documentation (if applicable)
  • I have added tests that prove my fix is effective or that my feature works (if applicable)

@paulromano paulromano added this to the v0.15.1 milestone Feb 24, 2025
@paulromano paulromano requested a review from shimwell as a code owner February 24, 2025 16:23
@shimwell
Copy link
Member

I'm seeing version 0.15 in the read the docs build for this PR

https://openmc--3320.org.readthedocs.build/en/3320/

Which is much better than the 0.1 I was seeing before this PR.

I wonder if we also what the last part of the version number which I guess would be something ilke 0.15.1-dev-hash

Screenshot From 2025-02-24 18-15-04

@paulromano
Copy link
Contributor Author

Good point @shimwell. I just pushed an update that will show the full version as I don't see any natural reason why it should only show the first time. I think that was just the default that Sphinx gives you unless you configure otherwise.

@shimwell
Copy link
Member

Confirmed that read the docs is showing the full version now, nice work

@shimwell
Copy link
Member

As this does not change the actual source code and fixes a live issue for a few users I think we can go ahead and merge this straight away.

I have enabled auto-merge.

Feel free to disable if anyone wants to keep this one open fro more time

@shimwell shimwell enabled auto-merge (squash) February 24, 2025 17:56
@shimwell shimwell merged commit 1729b3b into openmc-dev:develop Feb 25, 2025
15 checks passed
@paulromano paulromano deleted the version-fixes branch February 25, 2025 12:22
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.

latest documentation version number looks incorrect Unable to Build

2 participants