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

[DOC] update doc #569

Merged
merged 13 commits into from
Sep 18, 2023
Merged

[DOC] update doc #569

merged 13 commits into from
Sep 18, 2023

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Sep 3, 2023

  • closes Ensure examples in doc can actually build #568
  • switch to using the latest distro / software versions in examples
  • try to only show examples that are known to build
  • comment out section of the doc that are not relevant given the build failure status of some softwares
  • test the build of some of the examples
  • leave out nipype example out of the doc until fixed

@codecov
Copy link

codecov bot commented Sep 3, 2023

Codecov Report

Patch has no changes to coverable lines.

📢 Thoughts on this report? Let us know!.

@Remi-Gau Remi-Gau marked this pull request as ready for review September 3, 2023 18:01
@kaczmarj
Copy link
Collaborator

kaczmarj commented Sep 3, 2023

thanks very much!! this will help us catch regressions and make sure we don't confuse our users with broken tutorials :)

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Sep 3, 2023

am afraid the nipype tuto build will stay FUBAR for a little while
also I think it assumed that SPM would work with octave which is not something neurodocker supports anymore, right?

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Sep 4, 2023

Not sure what to do about the nipype example: getting this one to work won't be that easy

@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Sep 5, 2023

tempted to leave the testing of the nipype example out of this PR and trying to fix it in a separate one though I suspect this will be more efficiently tackled by solving other problems we have

so I would recommend commenting out this example from the doc for now so as to not confuse users

@Remi-Gau Remi-Gau mentioned this pull request Sep 18, 2023
@Remi-Gau Remi-Gau merged commit 5505223 into ReproNim:master Sep 18, 2023
13 checks passed
@Remi-Gau Remi-Gau deleted the update_doc branch September 18, 2023 02:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Ensure examples in doc can actually build
2 participants