Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions docs/source/en/_toctree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,8 @@
- sections:
- local: api/pipelines/overview
title: Overview
- local: api/pipelines/auto_pipeline
title: AutoPipeline
- sections:
- local: api/pipelines/audioldm
title: AudioLDM
Expand All @@ -462,8 +464,6 @@
- local: api/pipelines/stable_audio
title: Stable Audio
title: Audio
- local: api/pipelines/auto_pipeline
title: AutoPipeline
- sections:
- local: api/pipelines/amused
title: aMUSEd
Expand Down Expand Up @@ -527,6 +527,8 @@
title: HiDream-I1
- local: api/pipelines/hunyuandit
title: Hunyuan-DiT
- local: api/pipelines/hunyuanimage21
title: HunyuanImage2.1
- local: api/pipelines/pix2pix
title: InstructPix2Pix
- local: api/pipelines/kandinsky
Expand Down Expand Up @@ -640,8 +642,6 @@
title: ConsisID
- local: api/pipelines/framepack
title: Framepack
- local: api/pipelines/hunyuanimage21
title: HunyuanImage2.1
- local: api/pipelines/hunyuan_video
title: HunyuanVideo
- local: api/pipelines/i2vgenxl
Expand Down
22 changes: 12 additions & 10 deletions utils/check_doc_toc.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,20 +21,23 @@

PATH_TO_TOC = "docs/source/en/_toctree.yml"

# Titles that should maintain their position and not be sorted alphabetically
FIXED_POSITION_TITLES = {"overview", "autopipeline"}


def clean_doc_toc(doc_list):
"""
Cleans the table of content of the model documentation by removing duplicates and sorting models alphabetically.
"""
counts = defaultdict(int)
overview_doc = []
fixed_position_docs = []
new_doc_list = []
for doc in doc_list:
if "local" in doc:
counts[doc["local"]] += 1

if doc["title"].lower() == "overview":
overview_doc.append({"local": doc["local"], "title": doc["title"]})
if doc["title"].lower() in FIXED_POSITION_TITLES:
fixed_position_docs.append({"local": doc["local"], "title": doc["title"]})
else:
new_doc_list.append(doc)

Expand All @@ -57,14 +60,13 @@ def clean_doc_toc(doc_list):
new_doc.extend([doc for doc in doc_list if "local" not in counts or counts[doc["local"]] == 1])
new_doc = sorted(new_doc, key=lambda s: s["title"].lower())

# "overview" gets special treatment and is always first
if len(overview_doc) > 1:
raise ValueError("{doc_list} has two 'overview' docs which is not allowed.")

overview_doc.extend(new_doc)
# Fixed-position titles maintain their original order
result = []
for doc in fixed_position_docs:
result.append(doc)

# Sort
return overview_doc
result.extend(new_doc)
return result


def check_scheduler_doc(overwrite=False):
Expand Down
Loading