-
Notifications
You must be signed in to change notification settings - Fork 12
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
Update documentation #24
base: master
Are you sure you want to change the base?
Conversation
doc/overview.rst
Outdated
.. attention:: | ||
|
||
Please note that the code in this repository is compatible with the latest | ||
NEST version only; in particular the git "master" branch on |
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.
Is this accurate? Is the extension module really up-to-date to master and will always be?
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.
That is, at least, the theory :)
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.
This statement is already mentioned in extension_modules.rst
. Is this required here again?
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.
I would like to keep this as a highlight in README.rst as it's quite important to note.
doc/overview.rst
Outdated
.. attention:: | ||
|
||
Please note that the code in this repository is compatible with the latest | ||
NEST version only; in particular the git "master" branch on |
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.
This statement is already mentioned in extension_modules.rst
. Is this required here again?
Co-authored-by: Pooja Babu <[email protected]> Co-authored-by: jessica-mitchell <[email protected]>
build.sh
script in favour of better installation instructions on RtD and contents moved to GitHub workflow file