Skip to content

Python Doc Updates: Update dependencies, remove dead code (training section). - #32424

Merged
eserscor merged 17 commits into
mainfrom
dev/erscor/2026/9/3-doc-dependencies
Sep 9, 2026
Merged

eserscor merged 17 commits into
mainfrom
dev/erscor/2026/9/3-doc-dependencies

Conversation

@eserscor

@eserscor eserscor commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Description

Motivation and Context

@eserscor
eserscor marked this pull request as ready for review September 4, 2026 13:46
Copilot AI balanced review requested due to automatic review settings September 4, 2026 13:46
@eserscor
eserscor enabled auto-merge (squash) September 4, 2026 13:50

Copilot AI 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.

🟡 Changes recommended

The nightly package feed URL is invalid, and the undocumented removal of public training pages needs resolution.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Modernizes Python API documentation dependencies and execution while narrowing published docs to inference APIs.

Changes:

  • Replaces pyquickhelper with sphinx_exec_code.
  • Makes tutorial examples deterministic and executable.
  • Removes training documentation and updates the publishing workflow.
File summaries
File Description
docs/python/tutorial.rst Migrates executable tutorial examples.
docs/python/requirements.txt Updates Sphinx dependencies.
docs/python/ortmodule/overview.rst Removes ORTModule overview.
docs/python/ortmodule/api.rst Removes ORTModule API reference.
docs/python/on_device_training/training_artifacts.rst Removes artifact-generation documentation.
docs/python/on_device_training/training_api.rst Removes training API documentation.
docs/python/on_device_training/overview.rst Removes on-device training overview.
docs/python/index.rst Removes training sections from navigation.
docs/python/conf.py Enables sphinx_exec_code.
docs/python/_common/onnx_sphinx.py Removes obsolete dependency documentation.
.github/workflows/publish-python-apidocs.yml Changes runner, package source, and artifact conditions.
Review details
  • Files reviewed: 11/11 changed files
  • Comments generated: 3
  • Review effort level: Balanced

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/publish-python-apidocs.yml Outdated
Comment thread docs/python/index.rst
Comment thread .github/workflows/publish-python-apidocs.yml
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: eserscor <247253654+eserscor@users.noreply.github.com>
@eserscor eserscor changed the title Update python doc dependencies Python Doc Updates: Update dependencies, remove dead code (training section). Sep 4, 2026

@tianleiwu Tianlei Wu (tianleiwu) 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.

Summary

Documentation-only change; the Generate Python API docs check is green at this head (build succeeded, 16 warnings). The pyquickhelpersphinx_exec_code migration is clean and complete — I verified no dangling pyquickhelper / runpython / ORTModule / on_device_training references remain anywhere under docs/python or tools/doc, that pip install --dry-run -r docs/python/requirements.txt resolves without conflict in a clean venv, and that the # hide: start / # hide: stop markers are valid for sphinx-exec-code 0.18.

Two workflow changes look unintended, and the dependency cleanup stops short of a few remaining dead entries. Nothing blocking. Details inline.

Main points

  1. --pre onnxruntime --index-url <ORT-Nightly> does not install a nightly — the CI log for this head resolved onnxruntime-1.23.2 (stable). PEP 440 orders the feed's 1.23.0.dev* builds below the PyPI-proxied 1.23.2.
  2. The CPU-only Sphinx build was moved onto the A10 GPU pool.
  3. workflow_dispatch removal drops the only manual way to refresh a 10-day-retention artifact.

Out-of-diff cleanup (optional, same spirit as this PR)docs/python/conf.py still carries dead configuration that the passing build reports:

  • Lines 66-86: html_theme_options written for the pydata/RTD theme while html_theme = "furo", producing 10 WARNING: unsupported theme option ... messages (collapse_navigation, external_links, github_url, logo, navbar_center, navigation_depth, page_sidebar_items, show_nav_level, show_prev_next, show_toc_level).
  • Line 57: html_static_path = ["_static"]WARNING: html_static_path entry '_static' does not exist (the directory is absent).
  • Line 97: intersphinx_mapping still maps "torch" after torch >= 2.6.0 was dropped from requirements.txt; no torch cross-reference remains, so it is a per-build network fetch for nothing.

Clearing those would move the doc build closer to being able to run under -W.

Training doc removal — thorough and correct; dropping torch >= 2.6.0 is a meaningful CI win. The existing thread on docs/python/index.rst about the published ortmodule/* and on_device_training/* URLs starting to 404 is still open at this head; not restating it as a new comment, but a line in the PR description confirming the deprecation (or redirect stubs) would close it out.

Also, the PR description is currently empty — please fill in the Description / Motivation sections.

Comment thread .github/workflows/publish-python-apidocs.yml
Comment thread .github/workflows/publish-python-apidocs.yml Outdated
Comment thread .github/workflows/publish-python-apidocs.yml
Comment thread docs/python/requirements.txt Outdated
Comment thread docs/python/requirements.txt Outdated
Comment thread docs/python/tutorial.rst
@eserscor
eserscor merged commit 4d28551 into main Sep 9, 2026
90 of 91 checks passed
This was referenced Sep 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants