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.

Sign up for GitHub

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

Jump to bottom

DOC: Render doc website with Sphinx #2676

Merged
merged 13 commits into from
Oct 12, 2022
Merged

DOC: Render doc website with Sphinx #2676

merged 13 commits into from
Oct 12, 2022

Conversation

effigies
Copy link
Contributor

Will render here for now: https://effigies.github.io/openneuro/

  • Markdown rendering (MyST parser)
  • Dark/light, responsive theme (furo)
  • Syntax highlighting for graphql (not currently implemented in pygments)

@effigies effigies marked this pull request as ready for review September 30, 2022 12:45
@effigies effigies requested a review from nellh October 6, 2022 14:39
@effigies
Copy link
Contributor Author

effigies commented Oct 6, 2022

Added -W --keep-going flags to ensure we see when we have bad internal links or a dependency gives us a FutureWarning or some such. Example run: https://github.com/effigies/openneuro/actions/runs/3198147379

nellh
nellh approved these changes Oct 12, 2022
View reviewed changes
Copy link
Contributor

@nellh nellh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great and it's a big improvement over the current docs generator from a maintainability and usability standpoint. 👍

@nellh nellh merged commit 5e49d39 into OpenNeuroOrg:master Oct 12, 2022
@effigies
Copy link
Contributor Author

Thanks! Rendering on https://openneuroorg.github.io/openneuro/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nellh nellh nellh approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@effigies @nellh