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 docs #905

Merged
merged 2 commits into from
Oct 30, 2024
Merged

Fix API docs #905

merged 2 commits into from
Oct 30, 2024

Conversation

RemDelaporteMathurin
Copy link
Collaborator

Proposed changes

The docs won't compile in RTD because of the src structure.

Types of changes

What types of changes does your code introduce to FESTIM?

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Code refactoring
  • Documentation Update (if none of the other choices apply)
  • New tests

Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.69%. Comparing base (0c78549) to head (e8cafcc).
Report is 3 commits behind head on fenicsx.

Additional details and impacted files
@@           Coverage Diff            @@
##           fenicsx     #905   +/-   ##
========================================
  Coverage    97.69%   97.69%           
========================================
  Files           43       43           
  Lines         2042     2042           
========================================
  Hits          1995     1995           
  Misses          47       47           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RemDelaporteMathurin RemDelaporteMathurin changed the title add pip isntall . Fix API docs Oct 30, 2024
@RemDelaporteMathurin RemDelaporteMathurin marked this pull request as ready for review October 30, 2024 15:12
@RemDelaporteMathurin
Copy link
Collaborator Author

The docs now compile correctly:

image

@RemDelaporteMathurin RemDelaporteMathurin merged commit 013937a into fenicsx Oct 30, 2024
12 checks passed
@RemDelaporteMathurin RemDelaporteMathurin deleted the fix-docs branch October 30, 2024 15:12
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.

1 participant