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

Include version in docs #2812

Merged
merged 1 commit into from
Mar 14, 2025
Merged

Conversation

jku
Copy link
Member

@jku jku commented Mar 14, 2025

  • Without this when reading "stable" docs in readthedocs it's not clear what version the docs are for
  • This still leaves "latest" a little unclear on readthedocs (since we don't set a -dev version number after release) but this is still an improvement

Fixes #1568

@jku jku requested a review from a team as a code owner March 14, 2025 12:58
Otherwise on readthedocs it's not clear what version "latest" is.

Signed-off-by: Jussi Kukkonen <[email protected]>
@jku jku force-pushed the include-version-in-docs branch from 2503be0 to b690d8f Compare March 14, 2025 13:00
@jku
Copy link
Member Author

jku commented Mar 14, 2025

Copy link
Member

@joshuagl joshuagl left a comment

Choose a reason for hiding this comment

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

Nice improvement, thanks.

@coveralls
Copy link

Coverage Status

coverage: 97.076%. remained the same
when pulling b690d8f on jku:include-version-in-docs
into bb6d459 on theupdateframework:develop.

Comment on lines +1 to +2
Python-TUF |version| Developer Documentation
=======================================================================
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Python-TUF |version| Developer Documentation
=======================================================================
Python-TUF |version| Developer Documentation
============================================

Copy link
Member Author

Choose a reason for hiding this comment

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

I could have mentioned this: The issue is that the line needs to be at least as long as the title -- and we don't know how long the title is because of the variable expansion.

Luckily it's OK for the line to be longer

@jku jku merged commit ea88fde into theupdateframework:develop Mar 14, 2025
17 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: python-tuf version should be visible in docs (readthedocs)
4 participants