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

Update docs on fenicsx #931

Merged
merged 14 commits into from
Dec 20, 2024
Merged

Update docs on fenicsx #931

merged 14 commits into from
Dec 20, 2024

Conversation

RemDelaporteMathurin
Copy link
Collaborator

@RemDelaporteMathurin RemDelaporteMathurin commented Dec 20, 2024

Proposed changes

Enough is enough! We have been neglecting the fenicsx branch documentation for too long!

  • I took out most of the irrelevant stuff for FESTIM2 and added placeholder for now.
  • We now test the documentation again!

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

Choose a reason for hiding this comment

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

Copilot reviewed 61 out of 79 changed files in this pull request and generated no comments.

Files not reviewed (18)
  • docs/source/api/index.rst: Language not supported
  • docs/source/devguide/index.rst: Language not supported
  • docs/source/environment.yaml: Language not supported
  • docs/source/examples.rst: Language not supported
  • docs/source/getting_started.rst: Language not supported
  • docs/source/index.rst: Language not supported
  • docs/source/installation.rst: Language not supported
  • docs/source/userguide/beginners_guide.rst: Language not supported
  • docs/source/userguide/boundary_conditions.rst: Language not supported
  • docs/source/userguide/export_post_processing.rst: Language not supported
  • docs/source/userguide/index.rst: Language not supported
  • docs/source/userguide/materials.rst: Language not supported
  • docs/source/userguide/mesh.rst: Language not supported
  • docs/source/userguide/running_in_parallel.rst: Language not supported
  • docs/source/userguide/settings.rst: Language not supported
  • docs/source/userguide/simulations.rst: Language not supported
  • docs/source/userguide/temperature.rst: Language not supported
  • docs/source/userguide/traps.rst: Language not supported
Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.49%. Comparing base (effcbac) to head (57683e2).
Report is 15 commits behind head on fenicsx.

Additional details and impacted files
@@           Coverage Diff            @@
##           fenicsx     #931   +/-   ##
========================================
  Coverage    97.49%   97.49%           
========================================
  Files           44       44           
  Lines         2193     2193           
========================================
  Hits          2138     2138           
  Misses          55       55           

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

@RemDelaporteMathurin RemDelaporteMathurin added Documentation fenicsx Issue that is related to the fenicsx support labels Dec 20, 2024
@RemDelaporteMathurin RemDelaporteMathurin merged commit 0188da3 into fenicsx Dec 20, 2024
12 of 14 checks passed
@RemDelaporteMathurin RemDelaporteMathurin deleted the update-docs branch December 20, 2024 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation fenicsx Issue that is related to the fenicsx support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant