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

Fix API documentation #748

Merged
merged 4 commits into from
Jun 4, 2024
Merged

Fix API documentation #748

merged 4 commits into from
Jun 4, 2024

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented May 13, 2024

Closes #755.

I noticed that the API page was missing the actual documentation, so I'm trying to fix it here.

Changes proposed in this pull request

  • Adopt the API documentation approach from ASLPrep (which comes from fMRIPrep).
  • Fix the CLI documentation. The qsiprep-docker and qsiprep-singularity sections still aren't building though.
  • Remove Support and communication section from Usage page. It's redundant with the Getting Help page.
  • Fix workflow links in the preprocessing page.

Documentation that should be reviewed

  • API
  • Usage

tsalo added 2 commits May 13, 2024 10:05
The qsiprep-docker and qsiprep-singularity docs aren't building.
@tsalo tsalo marked this pull request as ready for review May 13, 2024 14:22
@tsalo tsalo requested a review from mattcieslak May 13, 2024 14:22
@tsalo
Copy link
Member Author

tsalo commented May 13, 2024

The individual workflows show up in my local HTML build, but not here. I need to figure out why.

@tsalo
Copy link
Member Author

tsalo commented Jun 3, 2024

It might be easier to just merge this as-is and revisit the workflow graphs and Docker/Apptainer interfaces in a future PR. @mattcieslak do you mind if I merge this?

@tsalo tsalo merged commit 3320ba4 into PennLINC:master Jun 4, 2024
3 checks passed
@tsalo tsalo deleted the fix-api branch June 4, 2024 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Parts of documentation not rendering for latest
1 participant