Skip to content

Commit cfe555f

Browse files
committed
Revert "added proper styling"
This reverts commit 344ee8a.
1 parent b973cd0 commit cfe555f

File tree

2 files changed

+39
-91
lines changed

2 files changed

+39
-91
lines changed

docs/source/en/_toctree.yml

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@
175175
title: gguf
176176
- local: quantization/torchao
177177
title: torchao
178-
- local: quantization/quanto
178+
- local: quantization/quanto
179179
title: quanto
180180
title: Quantization Methods
181181
- sections:
@@ -268,18 +268,18 @@
268268
- sections:
269269
- local: api/models/controlnet
270270
title: ControlNetModel
271-
- local: api/models/controlnet_union
272-
title: ControlNetUnionModel
273271
- local: api/models/controlnet_flux
274272
title: FluxControlNetModel
275273
- local: api/models/controlnet_hunyuandit
276274
title: HunyuanDiT2DControlNetModel
277-
- local: api/models/controlnet_sana
278-
title: SanaControlNetModel
279275
- local: api/models/controlnet_sd3
280276
title: SD3ControlNetModel
281277
- local: api/models/controlnet_sparsectrl
282278
title: SparseControlNetModel
279+
- local: api/models/controlnet_union
280+
title: ControlNetUnionModel
281+
- local: api/models/controlnet_sana
282+
title: SanaControlNetModel
283283
title: ControlNets
284284
- sections:
285285
- local: api/models/allegro_transformer3d
@@ -288,12 +288,12 @@
288288
title: AuraFlowTransformer2DModel
289289
- local: api/models/cogvideox_transformer3d
290290
title: CogVideoXTransformer3DModel
291+
- local: api/models/consisid_transformer3d
292+
title: ConsisIDTransformer3DModel
291293
- local: api/models/cogview3plus_transformer2d
292294
title: CogView3PlusTransformer2DModel
293295
- local: api/models/cogview4_transformer2d
294296
title: CogView4Transformer2DModel
295-
- local: api/models/consisid_transformer3d
296-
title: ConsisIDTransformer3DModel
297297
- local: api/models/dit_transformer2d
298298
title: DiTTransformer2DModel
299299
- local: api/models/easyanimate_transformer3d
@@ -306,12 +306,12 @@
306306
title: HunyuanVideoTransformer3DModel
307307
- local: api/models/latte_transformer3d
308308
title: LatteTransformer3DModel
309-
- local: api/models/ltx_video_transformer3d
310-
title: LTXVideoTransformer3DModel
311-
- local: api/models/lumina2_transformer2d
312-
title: Lumina2Transformer2DModel
313309
- local: api/models/lumina_nextdit2d
314310
title: LuminaNextDiT2DModel
311+
- local: api/models/lumina2_transformer2d
312+
title: Lumina2Transformer2DModel
313+
- local: api/models/ltx_video_transformer3d
314+
title: LTXVideoTransformer3DModel
315315
- local: api/models/mochi_transformer3d
316316
title: MochiTransformer3DModel
317317
- local: api/models/omnigen_transformer
@@ -320,10 +320,10 @@
320320
title: PixArtTransformer2DModel
321321
- local: api/models/prior_transformer
322322
title: PriorTransformer
323-
- local: api/models/sana_transformer2d
324-
title: SanaTransformer2DModel
325323
- local: api/models/sd3_transformer2d
326324
title: SD3Transformer2DModel
325+
- local: api/models/sana_transformer2d
326+
title: SanaTransformer2DModel
327327
- local: api/models/stable_audio_transformer
328328
title: StableAudioDiTModel
329329
- local: api/models/transformer2d
@@ -338,10 +338,10 @@
338338
title: StableCascadeUNet
339339
- local: api/models/unet
340340
title: UNet1DModel
341-
- local: api/models/unet2d-cond
342-
title: UNet2DConditionModel
343341
- local: api/models/unet2d
344342
title: UNet2DModel
343+
- local: api/models/unet2d-cond
344+
title: UNet2DConditionModel
345345
- local: api/models/unet3d-cond
346346
title: UNet3DConditionModel
347347
- local: api/models/unet-motion
@@ -350,10 +350,6 @@
350350
title: UViT2DModel
351351
title: UNets
352352
- sections:
353-
- local: api/models/asymmetricautoencoderkl
354-
title: AsymmetricAutoencoderKL
355-
- local: api/models/autoencoder_dc
356-
title: AutoencoderDC
357353
- local: api/models/autoencoderkl
358354
title: AutoencoderKL
359355
- local: api/models/autoencoderkl_allegro
@@ -370,6 +366,10 @@
370366
title: AutoencoderKLMochi
371367
- local: api/models/autoencoder_kl_wan
372368
title: AutoencoderKLWan
369+
- local: api/models/asymmetricautoencoderkl
370+
title: AsymmetricAutoencoderKL
371+
- local: api/models/autoencoder_dc
372+
title: AutoencoderDC
373373
- local: api/models/consistency_decoder_vae
374374
title: ConsistencyDecoderVAE
375375
- local: api/models/autoencoder_oobleck
@@ -515,40 +515,40 @@
515515
- sections:
516516
- local: api/pipelines/stable_diffusion/overview
517517
title: Overview
518-
- local: api/pipelines/stable_diffusion/depth2img
519-
title: Depth-to-image
520-
- local: api/pipelines/stable_diffusion/gligen
521-
title: GLIGEN (Grounded Language-to-Image Generation)
522-
- local: api/pipelines/stable_diffusion/image_variation
523-
title: Image variation
518+
- local: api/pipelines/stable_diffusion/text2img
519+
title: Text-to-image
524520
- local: api/pipelines/stable_diffusion/img2img
525521
title: Image-to-image
526522
- local: api/pipelines/stable_diffusion/svd
527523
title: Image-to-video
528524
- local: api/pipelines/stable_diffusion/inpaint
529525
title: Inpainting
530-
- local: api/pipelines/stable_diffusion/k_diffusion
531-
title: K-Diffusion
532-
- local: api/pipelines/stable_diffusion/latent_upscale
533-
title: Latent upscaler
534-
- local: api/pipelines/stable_diffusion/ldm3d_diffusion
535-
title: LDM3D Text-to-(RGB, Depth), Text-to-(RGB-pano, Depth-pano), LDM3D Upscaler
526+
- local: api/pipelines/stable_diffusion/depth2img
527+
title: Depth-to-image
528+
- local: api/pipelines/stable_diffusion/image_variation
529+
title: Image variation
536530
- local: api/pipelines/stable_diffusion/stable_diffusion_safe
537531
title: Safe Stable Diffusion
538-
- local: api/pipelines/stable_diffusion/sdxl_turbo
539-
title: SDXL Turbo
540532
- local: api/pipelines/stable_diffusion/stable_diffusion_2
541533
title: Stable Diffusion 2
542534
- local: api/pipelines/stable_diffusion/stable_diffusion_3
543535
title: Stable Diffusion 3
544536
- local: api/pipelines/stable_diffusion/stable_diffusion_xl
545537
title: Stable Diffusion XL
538+
- local: api/pipelines/stable_diffusion/sdxl_turbo
539+
title: SDXL Turbo
540+
- local: api/pipelines/stable_diffusion/latent_upscale
541+
title: Latent upscaler
546542
- local: api/pipelines/stable_diffusion/upscale
547543
title: Super-resolution
544+
- local: api/pipelines/stable_diffusion/k_diffusion
545+
title: K-Diffusion
546+
- local: api/pipelines/stable_diffusion/ldm3d_diffusion
547+
title: LDM3D Text-to-(RGB, Depth), Text-to-(RGB-pano, Depth-pano), LDM3D Upscaler
548548
- local: api/pipelines/stable_diffusion/adapter
549549
title: T2I-Adapter
550-
- local: api/pipelines/stable_diffusion/text2img
551-
title: Text-to-image
550+
- local: api/pipelines/stable_diffusion/gligen
551+
title: GLIGEN (Grounded Language-to-Image Generation)
552552
title: Stable Diffusion
553553
- local: api/pipelines/stable_unclip
554554
title: Stable unCLIP

utils/check_doc_toc.py

Lines changed: 4 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -123,13 +123,11 @@ def check_pipeline_doc(overwrite=False):
123123

124124
# sort sub pipeline docs
125125
for pipeline_doc in pipeline_docs:
126-
if "sections" in pipeline_doc:
127-
sub_pipeline_doc = pipeline_doc["sections"]
126+
if "section" in pipeline_doc:
127+
sub_pipeline_doc = pipeline_doc["section"]
128128
new_sub_pipeline_doc = clean_doc_toc(sub_pipeline_doc)
129-
if new_sub_pipeline_doc != sub_pipeline_doc:
130-
diff = True
131-
if overwrite:
132-
pipeline_doc["sections"] = new_sub_pipeline_doc
129+
if overwrite:
130+
pipeline_doc["section"] = new_sub_pipeline_doc
133131
new_pipeline_docs.append(pipeline_doc)
134132

135133
# sort overall pipeline doc
@@ -151,60 +149,10 @@ def check_pipeline_doc(overwrite=False):
151149
)
152150

153151

154-
def check_model_doc(overwrite=False):
155-
with open(PATH_TO_TOC, encoding="utf-8") as f:
156-
content = yaml.safe_load(f.read())
157-
158-
# Get to the API doc
159-
api_idx = 0
160-
while content[api_idx]["title"] != "API":
161-
api_idx += 1
162-
api_doc = content[api_idx]["sections"]
163-
164-
# Then to the model doc
165-
model_idx = 0
166-
while api_doc[model_idx]["title"] != "Models":
167-
model_idx += 1
168-
169-
diff = False
170-
model_docs = api_doc[model_idx]["sections"]
171-
new_model_docs = []
172-
173-
# sort sub model docs
174-
for model_doc in model_docs:
175-
if "sections" in model_doc:
176-
sub_model_doc = model_doc["sections"]
177-
new_sub_model_doc = clean_doc_toc(sub_model_doc)
178-
if new_sub_model_doc != sub_model_doc:
179-
diff = True
180-
if overwrite:
181-
model_doc["sections"] = new_sub_model_doc
182-
new_model_docs.append(model_doc)
183-
184-
# sort overall model doc
185-
new_model_docs = clean_doc_toc(new_model_docs)
186-
187-
if new_model_docs != model_docs:
188-
diff = True
189-
if overwrite:
190-
api_doc[model_idx]["sections"] = new_model_docs
191-
192-
if diff:
193-
if overwrite:
194-
content[api_idx]["sections"] = api_doc
195-
with open(PATH_TO_TOC, "w", encoding="utf-8") as f:
196-
f.write(yaml.dump(content, allow_unicode=True))
197-
else:
198-
raise ValueError(
199-
"The model doc part of the table of content is not properly sorted, run `make style` to fix this."
200-
)
201-
202-
203152
if __name__ == "__main__":
204153
parser = argparse.ArgumentParser()
205154
parser.add_argument("--fix_and_overwrite", action="store_true", help="Whether to fix inconsistencies.")
206155
args = parser.parse_args()
207156

208157
check_scheduler_doc(args.fix_and_overwrite)
209158
check_pipeline_doc(args.fix_and_overwrite)
210-
check_model_doc(args.fix_and_overwrite)

0 commit comments

Comments
 (0)