-
Notifications
You must be signed in to change notification settings - Fork 14
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
Major updates to documentation #267
Conversation
For the tutorial, I have still have to go over all the code blocks to make sure they are consistent, and check the line numbering and highlighting |
e076f43
to
a2cf2ce
Compare
Okay, I'm calling this ready. Documentation is a bit of a black hole for work, so it definitely could be improved still, but I think this is a good stopping point. Changes:
|
Also updated the authors field within pyproject.toml |
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.
Looks good to me, aside from the one comment.
Thanks for overhauling the documentation! 👏
EDIT: Forgot to mention I did notice there were some inconsistencies / typos from the portion of the docs being generated from the code. I don't think it is necessary for this PR, but we should go through and clean that up too at some point (or at least make corrections as see we see them).
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.
A couple of minor typos (I don't think I need to review it again) but this overall looks great to me, thanks for handling this!
11c998f
to
f407572
Compare
- Switch theme to furo - Use snakebids 1.0 syntax for BidsDataset - Update code blocks with line numbers and highlighting - Use literalincludes almost exclusively within tutorial to make maintenance easier - Update non-tutorial documentation files to 1.0 syntax - Add more links to attributes like zip_lists and path - Update typing annotations within source code for more consistency, and to take advantage of auto-documentation. - Add instructions to download example dataset - Various formatting fixes - Pin documentation dependencies - Remove unused sphinx extensions - Update package author list - Fix version update regexes
f407572
to
fddf1ed
Compare
Not quite finished yet, but I finished drafting the tutorial, so proofreads of that page should be appropriate if your able. Be sure to access the previous page via the actions console below to see the ui updates.