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] Fix failing docs on main #4079

Merged
merged 1 commit into from Oct 24, 2023
Merged

[DOC] Fix failing docs on main #4079

merged 1 commit into from Oct 24, 2023

Conversation

ymzayek
Copy link
Member

@ymzayek ymzayek commented Oct 24, 2023

No description provided.

@github-actions
Copy link
Contributor

👋 @ymzayek Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

  • PR has an interpretable title.
  • PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
  • Code is PEP8-compliant (see our documentation on coding style)
  • Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

  • There is at least one unit test per new function / class (see our documentation on testing)
  • The new feature is demoed in at least one relevant example.

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

@codecov
Copy link

codecov bot commented Oct 24, 2023

Codecov Report

Merging #4079 (66feaad) into main (697f77d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #4079   +/-   ##
=======================================
  Coverage   91.60%   91.60%           
=======================================
  Files         143      143           
  Lines       16096    16096           
  Branches     3347     3347           
=======================================
  Hits        14745    14745           
  Misses        804      804           
  Partials      547      547           
Flag Coverage Δ
macos-latest_3.10 91.50% <ø> (ø)
macos-latest_3.11 91.50% <ø> (?)
macos-latest_3.12 91.50% <ø> (ø)
macos-latest_3.8 91.46% <ø> (ø)
macos-latest_3.9 ?
ubuntu-latest_3.10 91.50% <ø> (ø)
ubuntu-latest_3.11 91.50% <ø> (ø)
ubuntu-latest_3.12 91.50% <ø> (ø)
ubuntu-latest_3.8 91.46% <ø> (ø)
ubuntu-latest_3.9 91.46% <ø> (ø)
windows-latest_3.10 91.44% <ø> (?)
windows-latest_3.11 ?
windows-latest_3.12 ?
windows-latest_3.8 ?
windows-latest_3.9 91.41% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Remi-Gau
Copy link
Collaborator

thanks @ymzayek

though I admit I am still confused as to why it works like this.

@Remi-Gau Remi-Gau merged commit 0260648 into nilearn:main Oct 24, 2023
32 checks passed
@ymzayek ymzayek deleted the fix-docs branch October 24, 2023 16:48
@ymzayek
Copy link
Member Author

ymzayek commented Oct 25, 2023

though I admit I am still confused as to why it works like this.

@Remi-Gau It's just the way we have it set up in doc/modules for glm. Autodoc will basicaly use these rst files as configuration files (see https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#). I don't know the ins and outs of it as I wasn't involved in setting it up but happy to discuss it in more detail

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.

None yet

2 participants