Skip to content

Combine documentation from all optimum subpackages #2353

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.

Sign up for GitHub

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

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from
Draft

Combine documentation from all optimum subpackages #2353

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d1c0b00
Combine documentation from all optimum subpackages
echarlaix Sep 15, 2025
ba8ec01
style
echarlaix Sep 15, 2025
0e9cc27
add links
echarlaix Sep 15, 2025
ff2f180
update workflow
echarlaix Sep 15, 2025
5572195
fix habana section title
echarlaix Sep 19, 2025
aab1d49
move habana section to make it closer to intel
echarlaix Sep 19, 2025
5c714d0
add redirects
echarlaix Sep 19, 2025
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
Prev Previous commit
Next Next commit
style
  • Loading branch information
@echarlaix
echarlaix committed Sep 15, 2025
commit ba8ec01bad4988101c13e6dc99f9a8454f7043bb
12 changes: 10 additions & 2 deletions docs/combine_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,19 @@ def rename_copy_subpackage_html_paths(subpackage: str, subpackage_path: Path, op


# for docs created separately that needs to be combined
#TODO: add AMD to EXTERNAL_DOCUMENTATION once added in optimum-amd
EXTERNAL_DOCUMENTATION = {"executorch": "ExecuTorch", "habana": "Habana", "intel": "Intel", "neuron": "Neuron", "onnx":"ONNX", "tpu": "TPU"}
# TODO: add AMD to EXTERNAL_DOCUMENTATION once added in optimum-amd
EXTERNAL_DOCUMENTATION = {
"executorch": "ExecuTorch",
"habana": "Habana",
"intel": "Intel",
"neuron": "Neuron",
"onnx": "ONNX",
"tpu": "TPU",
}
# needed for cases where the section title differs from the subpackage name
TITLE_SECTION = {"Neuron": "AWS Trainium/Inferentia", "TPU": "Google TPUs"}


def add_subpackage_doc(base_toc: List, subpackage: str):
"""
Extends the table of content with a section generated by the original optimum-xxx.
Expand Down