Skip to content

Conversation

@chaoming0625
Copy link
Member

@chaoming0625 chaoming0625 commented Oct 7, 2025

Summary by Sourcery

Introduce dynamic version-specific announcement in the documentation and remove legacy version-switching logic and files from the ReadTheDocs configuration.

Enhancements:

  • Replace static announcement banner in conf.py with a conditional message linking to either BrainPy 2.0 or 3.0 based on the build_version.

CI:

  • Simplify .readthedocs.yml by removing the post_checkout job and always using docs/conf.py for Sphinx configuration.

Documentation:

  • Remove the obsolete docs_version2 directory and its associated Makefile, conf.py, and make.bat.
  • Update .gitignore to eliminate references to the removed docs_version2 files.

@sourcery-ai
Copy link

sourcery-ai bot commented Oct 7, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR refactors the documentation build by introducing a dynamic announcement banner in the Sphinx configuration based on the build_version, streamlines the ReadTheDocs pipeline by removing the old post_checkout copy logic and pointing directly to a single conf.py, and deletes the obsolete docs_version2 directory and related artifacts.

Class diagram for dynamic announcement banner logic in conf.py

classDiagram
    class conf_py {
        +exclude_patterns
        +html_theme_options
        +announcement
        +build_version
    }
    conf_py : if build_version == 'v2' announcement = "...BrainPy 2.0..."
    conf_py : else announcement = "...BrainPy 3.0..."
Loading

File-Level Changes

Change Details Files
Introduce conditional announcement in Sphinx conf to switch between v2 and v3 API links.
  • Replaced static HTML announcement block with an if/else on build_version
  • Updated URLs and link text for both old and new API versions
docs/conf.py
Simplify ReadTheDocs configuration by removing custom copy jobs and using a single conf.py path.
  • Deleted post_checkout job script that copied docs based on DOC_BUILD_VERSION
  • Updated sphinx.configuration to reference docs/conf.py directly
.readthedocs.yml
Remove obsolete docs_version2 directory and its scaffolding files.
  • Deleted docs_version2 Makefile, conf.py, and make.bat
  • Removed docs_version2 entries from .gitignore
docs_version2/Makefile
docs_version2/conf.py
docs_version2/make.bat
.gitignore

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 7, 2025
@chaoming0625 chaoming0625 merged commit 2659cdf into master Oct 7, 2025
10 of 18 checks passed
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@chaoming0625 chaoming0625 deleted the v2.x branch October 7, 2025 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants