documentation fix#786
Merged
Merged
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
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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: