Skip to content

Conversation

@NeoZhangJianyu
Copy link
Contributor

@NeoZhangJianyu NeoZhangJianyu commented Nov 4, 2025

User description

Type of Change

bug fix

Description

fix the build script issue

Expected Behavior & Potential Risk

NA

How has this PR been tested?

test locally

Dependency Change?

NA


PR Type

Bug fix, Enhancement


Description

  • Update Sphinx and related dependencies

  • Remove unused API document example


Diagram Walkthrough

flowchart LR
  A["Update Sphinx and dependencies"] -- "Ensure compatibility" --> B["Remove unused API doc example"]
Loading

File Walkthrough

Relevant files
Dependencies
sphinx-requirements.txt
Update Sphinx and related dependencies                                     

docs/build_docs/sphinx-requirements.txt

  • Upgrade setuptools_scm[toml] to 9.2.2
  • Upgrade Sphinx to 8.2.3
  • Upgrade sphinx-autoapi to 3.6.1
  • Upgrade sphinx-autobuild to 2025.8.25
  • Upgrade sphinx_rtd_theme to 3.0.2
+5/-5     
Documentation
api_2.rst
Remove unused API document example                                             

docs/source/api-doc/api_2.rst

  • Remove api_doc_example.rst from toctree
+0/-4     
api_doc_example.rst
Remove unused API document example file                                   

docs/source/api-doc/api_doc_example.rst

  • Delete entire file
+0/-6     

@PRAgent4INC
Copy link
Collaborator

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Version Compatibility

Ensure that the updated versions of Sphinx and its dependencies are compatible with the existing documentation setup and do not introduce breaking changes.

setuptools_scm[toml]==9.2.2
Sphinx==8.2.3
sphinx-autoapi==3.6.1
sphinx-autobuild==2025.8.25
sphinx-markdown-tables==0.0.17
sphinx-md==0.0.4
sphinx_rtd_theme==3.0.2
Documentation Structure

Verify that removing the api_doc_example.rst does not affect the overall structure and completeness of the API documentation.

**Advanced APIs:**

.. toctree::
   :maxdepth: 1

   compression.rst
   strategy.rst
   model.rst

@PRAgent4INC
Copy link
Collaborator

PR Code Suggestions ✨

No code suggestions found for the PR.

@thuang6 thuang6 requested a review from chensuyue November 5, 2025 00:34
@NeoZhangJianyu NeoZhangJianyu merged commit 864f402 into master Nov 5, 2025
11 checks passed
@NeoZhangJianyu NeoZhangJianyu deleted the jianyuzh_fix_online_doc_build branch November 5, 2025 01:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants