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

Fix basic/full tutorial order #250

Merged
merged 1 commit into from
Oct 16, 2023
Merged

Fix basic/full tutorial order #250

merged 1 commit into from
Oct 16, 2023

Conversation

RLKRo
Copy link
Member

@RLKRo RLKRo commented Oct 12, 2023

Description

I previously reported the problem here. As far as I remember, I later saw that everything on the site was in order and forgot about it.

However, at this moment tutorials are again out of order.
Although, this time, it's different tutorials that are out of order.

I ran locally make doc ~4 times and every time it was a different set of tutorials that were out of order.

This issue is caused by sort_tutorial_file_tree which sorts files that have a numerical prefix by that prefix. This function does not account for multiple tutorials with the same prefix in the same directory.

As a potential solution: the key function adds 0.5 to tutorials that end with _full.

Checklist

  • I have covered the code with tests
  • I have added comments to my code to help others understand it
  • I have updated the documentation to reflect the changes
  • I have performed a self-review of the changes

@RLKRo RLKRo added bug Something isn't working documentation Improvements or additions to documentation labels Oct 12, 2023
@RLKRo RLKRo merged commit 742bf71 into dev Oct 16, 2023
17 checks passed
@RLKRo RLKRo mentioned this pull request Oct 16, 2023
4 tasks
RLKRo added a commit that referenced this pull request Oct 17, 2023
# Release notes

- Add docker profiles (#246)
- Add Context guide (#244)
- Rework basic guide (#209)
- Change documentation build configuration (#250, #249)
- Various documentation updates (#245, #244, #246)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant