Add BrainPy citation and update documentation#770
Merged
Merged
Conversation
…ns and update citation details
Reviewer's GuideEnhance project documentation by refining the README foundation description, replacing outdated links with a general ecosystem reference, embedding a detailed BibTeX citation, removing stale changelog links from the API docs, and extending the index rst with an Ecosystem installation tab and updated Learn More section. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey @chaoming0625 - I've reviewed your changes and they look great!
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Member
Author
|
@sourcery-ai title |
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.
This pull request includes updates to the
README.mdand documentation files to improve clarity, provide updated references, and enhance usability. The most important changes include updating references to BrainPy's ecosystem and documentation, adding citation details for the BrainPy framework, and reorganizing the API documentation structure.Updates to
README.md:brainstatesince August 2025.brainpy-datasetswith a more general reference to the "brain modeling ecosystem."Documentation improvements:
brainpy-changelog.mdandbrainpylib-changelog.md) from thedocs/api.rstfile, likely to streamline the API documentation.docs/index.rstwith commands for installingBrainXon different platforms (CPU, CUDA, TPU).docs/index.rstto include changelog links and fixed an outdated example link. [1] [2]Summary by Sourcery
Enhance README and documentation by updating BrainPy references, adding citation details, and improving the ecosystem installation and API docs structure
New Features:
Enhancements:
Documentation: