Skip to content

Commit aba2a65

Browse files
patrickvonplatenpatrickvonplaten
authored
Add automatic doc sorting (huggingface#1940)
* automatically sort docs * add new check toc doc * add new check toc doc * add * add new check toc doc * add * add new check toc doc * correct * finalize
1 parent 9f4c4f5 commit aba2a65

File tree

3 files changed

+270
-111
lines changed

3 files changed

+270
-111
lines changed

‎Makefile‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,14 @@ quality:
4545
isort --check-only $(check_dirs)
4646
flake8 $(check_dirs)
4747
doc-builder style src/diffusers docs/source --max_len 119 --check_only --path_to_docs docs/source
48+
python utils/check_doc_toc.py
4849

4950
# Format source code automatically and check is there are any problems left that need manual fixing
5051

5152
extra_style_checks:
5253
python utils/custom_init_isort.py
5354
doc-builder style src/diffusers docs/source --max_len 119 --path_to_docs docs/source
55+
python utils/check_doc_toc.py --fix_and_overwrite
5456

5557
# this target runs checks on all files and potentially modifies some of them
5658

‎docs/source/en/_toctree.yml‎

Lines changed: 110 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,195 +1,194 @@
11
- sections:
22
- local: index
3-
title: "🧨 Diffusers"
3+
title: 🧨 Diffusers
44
- local: quicktour
5-
title: "Quicktour"
5+
title: Quicktour
66
- local: stable_diffusion
7-
title: "Stable Diffusion"
7+
title: Stable Diffusion
88
- local: installation
9-
title: "Installation"
10-
title: "Get started"
9+
title: Installation
10+
title: Get started
1111
- sections:
1212
- sections:
1313
- local: using-diffusers/loading
14-
title: "Loading Pipelines, Models, and Schedulers"
14+
title: Loading Pipelines, Models, and Schedulers
1515
- local: using-diffusers/schedulers
16-
title: "Using different Schedulers"
16+
title: Using different Schedulers
1717
- local: using-diffusers/configuration
18-
title: "Configuring Pipelines, Models, and Schedulers"
18+
title: Configuring Pipelines, Models, and Schedulers
1919
- local: using-diffusers/custom_pipeline_overview
20-
title: "Loading and Adding Custom Pipelines"
21-
title: "Loading & Hub"
20+
title: Loading and Adding Custom Pipelines
21+
title: Loading & Hub
2222
- sections:
2323
- local: using-diffusers/unconditional_image_generation
24-
title: "Unconditional Image Generation"
24+
title: Unconditional Image Generation
2525
- local: using-diffusers/conditional_image_generation
26-
title: "Text-to-Image Generation"
26+
title: Text-to-Image Generation
2727
- local: using-diffusers/img2img
28-
title: "Text-Guided Image-to-Image"
28+
title: Text-Guided Image-to-Image
2929
- local: using-diffusers/inpaint
30-
title: "Text-Guided Image-Inpainting"
30+
title: Text-Guided Image-Inpainting
3131
- local: using-diffusers/depth2img
32-
title: "Text-Guided Depth-to-Image"
32+
title: Text-Guided Depth-to-Image
3333
- local: using-diffusers/reusing_seeds
34-
title: "Reusing seeds for deterministic generation"
34+
title: Reusing seeds for deterministic generation
3535
- local: using-diffusers/custom_pipeline_examples
36-
title: "Community Pipelines"
36+
title: Community Pipelines
3737
- local: using-diffusers/contribute_pipeline
38-
title: "How to contribute a Pipeline"
39-
title: "Pipelines for Inference"
38+
title: How to contribute a Pipeline
39+
title: Pipelines for Inference
4040
- sections:
4141
- local: using-diffusers/rl
42-
title: "Reinforcement Learning"
42+
title: Reinforcement Learning
4343
- local: using-diffusers/audio
44-
title: "Audio"
44+
title: Audio
4545
- local: using-diffusers/other-modalities
46-
title: "Other Modalities"
47-
title: "Taking Diffusers Beyond Images"
48-
title: "Using Diffusers"
46+
title: Other Modalities
47+
title: Taking Diffusers Beyond Images
48+
title: Using Diffusers
4949
- sections:
5050
- local: optimization/fp16
51-
title: "Memory and Speed"
51+
title: Memory and Speed
5252
- local: optimization/xformers
53-
title: "xFormers"
53+
title: xFormers
5454
- local: optimization/onnx
55-
title: "ONNX"
55+
title: ONNX
5656
- local: optimization/open_vino
57-
title: "OpenVINO"
57+
title: OpenVINO
5858
- local: optimization/mps
59-
title: "MPS"
59+
title: MPS
6060
- local: optimization/habana
61-
title: "Habana Gaudi"
62-
title: "Optimization/Special Hardware"
61+
title: Habana Gaudi
62+
title: Optimization/Special Hardware
6363
- sections:
6464
- local: training/overview
65-
title: "Overview"
65+
title: Overview
6666
- local: training/unconditional_training
67-
title: "Unconditional Image Generation"
67+
title: Unconditional Image Generation
6868
- local: training/text_inversion
69-
title: "Textual Inversion"
69+
title: Textual Inversion
7070
- local: training/dreambooth
71-
title: "Dreambooth"
71+
title: Dreambooth
7272
- local: training/text2image
73-
title: "Text-to-image fine-tuning"
74-
title: "Training"
73+
title: Text-to-image fine-tuning
74+
title: Training
7575
- sections:
7676
- local: conceptual/philosophy
77-
title: "Philosophy"
77+
title: Philosophy
7878
- local: conceptual/contribution
79-
title: "How to contribute?"
80-
title: "Conceptual Guides"
79+
title: How to contribute?
80+
title: Conceptual Guides
8181
- sections:
8282
- sections:
8383
- local: api/models
84-
title: "Models"
84+
title: Models
8585
- local: api/diffusion_pipeline
86-
title: "Diffusion Pipeline"
86+
title: Diffusion Pipeline
8787
- local: api/logging
88-
title: "Logging"
88+
title: Logging
8989
- local: api/configuration
90-
title: "Configuration"
90+
title: Configuration
9191
- local: api/outputs
92-
title: "Outputs"
93-
title: "Main Classes"
94-
92+
title: Outputs
93+
title: Main Classes
9594
- sections:
9695
- local: api/pipelines/overview
97-
title: "Overview"
96+
title: Overview
9897
- local: api/pipelines/alt_diffusion
99-
title: "AltDiffusion"
98+
title: AltDiffusion
99+
- local: api/pipelines/audio_diffusion
100+
title: Audio Diffusion
100101
- local: api/pipelines/cycle_diffusion
101-
title: "Cycle Diffusion"
102+
title: Cycle Diffusion
103+
- local: api/pipelines/dance_diffusion
104+
title: Dance Diffusion
102105
- local: api/pipelines/ddim
103-
title: "DDIM"
106+
title: DDIM
104107
- local: api/pipelines/ddpm
105-
title: "DDPM"
108+
title: DDPM
106109
- local: api/pipelines/latent_diffusion
107-
title: "Latent Diffusion"
108-
- local: api/pipelines/latent_diffusion_uncond
109-
title: "Unconditional Latent Diffusion"
110+
title: Latent Diffusion
110111
- local: api/pipelines/paint_by_example
111-
title: "PaintByExample"
112+
title: PaintByExample
112113
- local: api/pipelines/pndm
113-
title: "PNDM"
114+
title: PNDM
115+
- local: api/pipelines/repaint
116+
title: RePaint
117+
- local: api/pipelines/stable_diffusion_safe
118+
title: Safe Stable Diffusion
114119
- local: api/pipelines/score_sde_ve
115-
title: "Score SDE VE"
120+
title: Score SDE VE
116121
- sections:
117122
- local: api/pipelines/stable_diffusion/overview
118-
title: "Overview"
123+
title: Overview
119124
- local: api/pipelines/stable_diffusion/text2img
120-
title: "Text-to-Image"
125+
title: Text-to-Image
121126
- local: api/pipelines/stable_diffusion/img2img
122-
title: "Image-to-Image"
127+
title: Image-to-Image
123128
- local: api/pipelines/stable_diffusion/inpaint
124-
title: "Inpaint"
129+
title: Inpaint
125130
- local: api/pipelines/stable_diffusion/depth2img
126-
title: "Depth-to-Image"
131+
title: Depth-to-Image
127132
- local: api/pipelines/stable_diffusion/image_variation
128-
title: "Image-Variation"
133+
title: Image-Variation
129134
- local: api/pipelines/stable_diffusion/upscale
130-
title: "Super-Resolution"
131-
title: "Stable Diffusion"
135+
title: Super-Resolution
136+
title: Stable Diffusion
132137
- local: api/pipelines/stable_diffusion_2
133-
title: "Stable Diffusion 2"
134-
- local: api/pipelines/stable_diffusion_safe
135-
title: "Safe Stable Diffusion"
138+
title: Stable Diffusion 2
136139
- local: api/pipelines/stochastic_karras_ve
137-
title: "Stochastic Karras VE"
138-
- local: api/pipelines/dance_diffusion
139-
title: "Dance Diffusion"
140+
title: Stochastic Karras VE
140141
- local: api/pipelines/unclip
141-
title: "UnCLIP"
142+
title: UnCLIP
143+
- local: api/pipelines/latent_diffusion_uncond
144+
title: Unconditional Latent Diffusion
142145
- local: api/pipelines/versatile_diffusion
143-
title: "Versatile Diffusion"
146+
title: Versatile Diffusion
144147
- local: api/pipelines/vq_diffusion
145-
title: "VQ Diffusion"
146-
- local: api/pipelines/repaint
147-
title: "RePaint"
148-
- local: api/pipelines/audio_diffusion
149-
title: "Audio Diffusion"
150-
title: "Pipelines"
148+
title: VQ Diffusion
149+
title: Pipelines
151150
- sections:
152151
- local: api/schedulers/overview
153-
title: "Overview"
152+
title: Overview
154153
- local: api/schedulers/ddim
155-
title: "DDIM"
154+
title: DDIM
156155
- local: api/schedulers/ddpm
157-
title: "DDPM"
156+
title: DDPM
158157
- local: api/schedulers/deis
159-
title: "DEIS"
160-
- local: api/schedulers/singlestep_dpm_solver
161-
title: "Singlestep DPM-Solver"
162-
- local: api/schedulers/multistep_dpm_solver
163-
title: "Multistep DPM-Solver"
164-
- local: api/schedulers/heun
165-
title: "Heun Scheduler"
158+
title: DEIS
166159
- local: api/schedulers/dpm_discrete
167-
title: "DPM Discrete Scheduler"
160+
title: DPM Discrete Scheduler
168161
- local: api/schedulers/dpm_discrete_ancestral
169-
title: "DPM Discrete Scheduler with ancestral sampling"
170-
- local: api/schedulers/stochastic_karras_ve
171-
title: "Stochastic Kerras VE"
162+
title: DPM Discrete Scheduler with ancestral sampling
163+
- local: api/schedulers/euler_ancestral
164+
title: Euler Ancestral Scheduler
165+
- local: api/schedulers/euler
166+
title: Euler scheduler
167+
- local: api/schedulers/heun
168+
title: Heun Scheduler
169+
- local: api/schedulers/ipndm
170+
title: IPNDM
172171
- local: api/schedulers/lms_discrete
173-
title: "Linear Multistep"
172+
title: Linear Multistep
173+
- local: api/schedulers/multistep_dpm_solver
174+
title: Multistep DPM-Solver
174175
- local: api/schedulers/pndm
175-
title: "PNDM"
176+
title: PNDM
177+
- local: api/schedulers/repaint
178+
title: RePaint Scheduler
179+
- local: api/schedulers/singlestep_dpm_solver
180+
title: Singlestep DPM-Solver
181+
- local: api/schedulers/stochastic_karras_ve
182+
title: Stochastic Kerras VE
176183
- local: api/schedulers/score_sde_ve
177-
title: "VE-SDE"
178-
- local: api/schedulers/ipndm
179-
title: "IPNDM"
184+
title: VE-SDE
180185
- local: api/schedulers/score_sde_vp
181-
title: "VP-SDE"
182-
- local: api/schedulers/euler
183-
title: "Euler scheduler"
184-
- local: api/schedulers/euler_ancestral
185-
title: "Euler Ancestral Scheduler"
186+
title: VP-SDE
186187
- local: api/schedulers/vq_diffusion
187-
title: "VQDiffusionScheduler"
188-
- local: api/schedulers/repaint
189-
title: "RePaint Scheduler"
190-
title: "Schedulers"
188+
title: VQDiffusionScheduler
189+
title: Schedulers
191190
- sections:
192191
- local: api/experimental/rl
193-
title: "RL Planning"
194-
title: "Experimental Features"
195-
title: "API"
192+
title: RL Planning
193+
title: Experimental Features
194+
title: API

0 commit comments

Comments
 (0)