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

De-duplicate the version numbers in the project #285

Merged
merged 1 commit into from Sep 22, 2023

Conversation

kurtmckee
Copy link
Contributor

I observed that the documentation version needed a recent fixup (44a913d); this PR eliminates the possibility that the version numbers fall out of sync between the project and its documentation.

@codecov-commenter
Copy link

codecov-commenter commented Sep 19, 2023

Codecov Report

Merging #285 (dcaa85c) into master (44a913d) will not change coverage.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@            Coverage Diff            @@
##            master      #285   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          666       666           
=========================================
  Hits           666       666           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@tkem
Copy link
Owner

tkem commented Sep 21, 2023

@kurtmckee Looking at the history of docs/conf.py, you probably noticed several attempts to achieve this, howver it failed at some time and so at some point I just gave up on this...
I will nevertheless review your contributions, and I'm quite sure they are up-to-date and will get merged, but it'll take some time.

@tkem
Copy link
Owner

tkem commented Sep 21, 2023

Sorry, I cannot get this to work, please repost your PR based on current HEAD...

@tkem tkem closed this Sep 21, 2023
@kurtmckee
Copy link
Contributor Author

Was there an error message that you were seeing, like a FileNotFound exception or some such?

@kurtmckee
Copy link
Contributor Author

kurtmckee commented Sep 21, 2023

I double-checked, and I think this PR is based on current HEAD (the parent commit is 44a913d).

Could you share more details about the way that it didn't work? For example, we may have a difference in Python implementations or versions, or invocations (like using make vs tox for testing), or perhaps something else is happening.

I tested this by running tox -e docs and then confirmed that the version appeared as expected in the generated docs in .tox/docs/tmp/html, but I'm interested to understand how you tested so I can account for it in this PR.

Thanks for taking the time to review this!

@tkem tkem reopened this Sep 22, 2023
@tkem
Copy link
Owner

tkem commented Sep 22, 2023

Probably my bad, sorry. I'll re-check ASAP.

@tkem tkem merged commit 777fc70 into tkem:master Sep 22, 2023
18 checks passed
@tkem
Copy link
Owner

tkem commented Sep 22, 2023

Sorry for the troubles, I seem to have somehow wrecked my setup on my secondary machine, and yesterday was kind of a long working day...

@kurtmckee
Copy link
Contributor Author

I understand long work days well! Thanks for revisiting this!

@kurtmckee kurtmckee deleted the de-duplicate-versions branch September 22, 2023 11:54
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.

None yet

3 participants