-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
feat: Adding version switcher to Triton sphinx documentation #7872
Conversation
54e9685
to
b02cf81
Compare
b02cf81
to
93ad2c1
Compare
Hi @nv-kmcgill53. In generate_docs.py, there are some regular expression hard coded with Ideally, when users view the docs from an previous version, all the hyperlinks should point to docs/files from the same previous release version. |
I think I see what you are saying and I don't believe this applies to this change. The switcher links to the archived docs in the triton archives. This should mean that I don't have to worry about the regex in the current documentation since, when clicking on the switcher, it takes the user to the older docs. Here is a sample of the data which the switcher is using for the select-ables:
|
Then it should be fine. I want to point out that the links in https://docs.nvidia.com/deeplearning/triton-inference-server/archives/ are wrong. For example, Links under "Release 2.49.0" points to |
That's odd. I'll talk to the docs team about that |
@yinggeh You will have to build the docs locally and un-comment this line before building the docs. The reason why you are getting the wrong thing is that the switcher is attempting to get the |
80a764c
to
e7d226d
Compare
version_short = release | ||
# Theme options are theme-specific and customize the look and feel of a theme | ||
# further. For a list of options available for each theme, see the | ||
# documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add the link to this documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left comments. LGTM otherwise. Thanks for the contribution!
} | ||
|
||
version_short = release | ||
# Theme options are theme-specific and customize the look and feel of a theme | ||
# further. For a list of options available for each theme, see the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# further. For a list of options available for each theme, see the | |
# further. For a list of options available for each theme, see the |
Closing this as these changes got picked into this branch: #7807 |
What does the PR do?
This PR adds a switcher to pick different versions of Triton documentation. These changes:
Checklist
<commit_type>: <Title>
Commit Type:
Check the conventional commit type
box here and add the label to the github PR.
Related PRs:
None
Where should the reviewer start?
This is a single file PR, not applicable.
Test plan:
21363299
Caveats:
Right now we are using the major/minor/patch format for the version instead of the year/month format. This might be future work depending on the time it takes to develop this for 24.12
Background
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
N/A