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.

Sign up for GitHub

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

Include version in docs #2812

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
TUF Developer Documentation
===========================
Python-TUF |version| Developer Documentation
=======================================================================
Comment on lines +1 to +2
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


This documentation provides essential information for those developing software
with the `Python reference implementation of The Update Framework (TUF)
Expand Down