Skip to content

Conversation

@sgugger
Copy link
Collaborator

@sgugger sgugger commented Jul 5, 2022

What does this PR do?

This PR adds a script to automatically sort the model doc part of the documentation ToC, so we never need things like #18011 ever again.

The script runs in the traditional make style/fixup/quality setup meaning that:

  • make style or make fixup fix the ToC by auto-sorting it and removing duplicates
  • make quality just checks whether or not the ToC is properly sorted.

@sgugger sgugger requested a review from LysandreJik July 5, 2022 18:11
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jul 5, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Member

@LysandreJik LysandreJik left a comment

Choose a reason for hiding this comment

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

Very nice! 🥳

Thanks for working on it, this is cool

@sgugger sgugger merged commit 1b749a7 into main Jul 7, 2022
@sgugger sgugger deleted the sort_doc_toc branch July 7, 2022 12:18
viclzhu pushed a commit to viclzhu/transformers that referenced this pull request Jul 18, 2022
* Add script to sort doc ToC

* Style and fixes

* Add check to quality job
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.

4 participants