-
Notifications
You must be signed in to change notification settings - Fork 101
documentation fix #786
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.
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
documentation fix #786
Conversation
…ude stable versions
…lude 'latest' version
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis 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.pyclassDiagram
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..."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary by Sourcery
Introduce dynamic version-specific announcement in the documentation and remove legacy version-switching logic and files from the ReadTheDocs configuration.
Enhancements:
CI:
Documentation: