Skip to content
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

Merged
merged 1 commit into from
Apr 7, 2023
Merged

Conversation

pvandyken
Copy link
Contributor

  • Switch theme to furo
  • Use snakebids 1.0 syntax for BidsDataset
  • Update code blocks with line numbers and highlighting

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.

@pvandyken
Copy link
Contributor Author

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

@pvandyken
Copy link
Contributor Author

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:

  • 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

@pvandyken
Copy link
Contributor Author

Also updated the authors field within pyproject.toml

Copy link
Contributor

@kaitj kaitj left a 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).

docs/bids_app/config.md Show resolved Hide resolved
@pvandyken pvandyken linked an issue Apr 4, 2023 that may be closed by this pull request
1 task
Copy link
Contributor

@tkkuehn tkkuehn left a 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!

docs/tutorial/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/tutorial.md Outdated Show resolved Hide resolved
@pvandyken pvandyken added the documentation Improvements or additions to documentation label Apr 7, 2023
- 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
@pvandyken pvandyken merged commit c1498af into khanlab:main Apr 7, 2023
@pvandyken pvandyken deleted the docs-1.0-syntax branch April 7, 2023 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation to consistently use new BidsDataset syntax
3 participants