Skip to content

[1/x] docs update#3743

Merged
vkuzo merged 4 commits into
mainfrom
gh/vkuzo/198/head
Jan 29, 2026
Merged

[1/x] docs update#3743
vkuzo merged 4 commits into
mainfrom
gh/vkuzo/198/head

Conversation

@vkuzo

@vkuzo vkuzo commented Jan 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary:

Starts the process to clean up the docs. Specifically:

  • intro (keep today's content) - no change
  • getting started (keep today's content) - no change
  • API reference (keep today's content) - make a dir and hide from top level
  • tutorials (keep today's content) - make a dir and hide from top level
  • contributing (keep today's content) - rename "developer notes" to "contributing", make this a dir and remove from top level, move in order to here
  • pt2e quantization tutorials - make a dir and hide from top level

There are no changes to any actual docs in this PR, we are just adding a subdirectory structure and moving docs into various subdirectories.

Test Plan: look at doc page in CI

@vkuzo
Update
ddad42c 
[ghstack-poisoned]
@vkuzo

vkuzo commented Jan 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Stack from ghstack (oldest at bottom):

@pytorch-bot

pytorch-bot Bot commented Jan 28, 2026 •
edited
Loading

Copy link
Copy Markdown

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/pytorch/ao/3743

Note: Links to docs will display an error until the docs builds have been completed.

✅ No Failures

As of commit 8bcbfcf with merge base 8940de9 (image):
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

vkuzo added a commit that referenced this pull request Jan 28, 2026
@vkuzo
[wip] docs update
0116499 
Summary:

Test Plan:
ghstack-source-id: d96af3b
ghstack-comment-id: 3813058962
Pull-Request: #3743
@meta-cla meta-cla Bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jan 28, 2026
@vkuzo
Update
6ffdb85 
[ghstack-poisoned]
vkuzo added a commit that referenced this pull request Jan 29, 2026
@vkuzo
[wip] docs update
cd8bfec 
Summary:

Test Plan:
ghstack-source-id: 22d7f2b
ghstack-comment-id: 3813058962
Pull-Request: #3743
@vkuzo
Update
c38dbb3 
[ghstack-poisoned]
vkuzo added a commit that referenced this pull request Jan 29, 2026
@vkuzo
[wip] docs update
d31c373 
Summary:

Test Plan:
ghstack-source-id: 9ff2eab
ghstack-comment-id: 3813058962
Pull-Request: #3743
@vkuzo vkuzo added the topic: documentation Use this tag if this PR adds or improves documentation label Jan 29, 2026
@github-actions

github-actions Bot commented Jan 29, 2026

Copy link
Copy Markdown
Contributor

📄 Doc Preview (workflow_dispatch)

You triggered a doc build manually via workflow_dispatch.
The pytorchbot doc preview link will not work for this build.

Use this link instead: https://docs-preview.pytorch.org/pytorch/ao/21487588291/index.html

@vkuzo
Update
8bcbfcf 
[ghstack-poisoned]
vkuzo added a commit that referenced this pull request Jan 29, 2026
@vkuzo
[wip] docs update
37a81e2 
Summary:

Test Plan:
ghstack-source-id: 078ee9b
ghstack-comment-id: 3813058962
Pull-Request: #3743
@vkuzo vkuzo changed the title [wip] docs update [1/x] docs update Jan 29, 2026
This was referenced Jan 29, 2026
Merged
Merged
Merged
jerryzh168
jerryzh168 reviewed Jan 29, 2026
View reviewed changes
Comment thread docs/source/index.rst
tutorials_source/pt2e_quant_xpu_inductor
tutorials_source/pt2e_quant_openvino_inductor
tutorials_source/pt2e_quantizer
pt2e_quantization/index

@jerryzh168 jerryzh168 Jan 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: maybe swap the order of Developer Notes and pt2e quant, as pt2e quant is user facing and developer notes is developer facing

jerryzh168
jerryzh168 approved these changes Jan 29, 2026
View reviewed changes

@jerryzh168 jerryzh168 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@vkuzo vkuzo mentioned this pull request Jan 29, 2026
Merged
@vkuzo vkuzo merged commit 7ad9dc7 into main Jan 29, 2026
60 of 66 checks passed
@vkuzo vkuzo mentioned this pull request Jan 29, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jerryzh168 jerryzh168 jerryzh168 approved these changes

Assignees

No one assigned

Labels

CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. topic: documentation Use this tag if this PR adds or improves documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@vkuzo @jerryzh168