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

Documentation guide #779

Merged
merged 4 commits into from
Jun 11, 2024
Merged

Documentation guide #779

merged 4 commits into from
Jun 11, 2024

Conversation

RemDelaporteMathurin
Copy link
Collaborator

Proposed changes

Fixes #778 by adding a guide to building the documentation in the docs.

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

@RemDelaporteMathurin
Copy link
Collaborator Author

@KulaginVladimir do you think there's anything I missed here?

Copy link

codecov bot commented Jun 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.53%. Comparing base (36da67b) to head (94fccf1).
Report is 167 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #779   +/-   ##
=======================================
  Coverage   99.53%   99.53%           
=======================================
  Files          59       59           
  Lines        2577     2577           
=======================================
  Hits         2565     2565           
  Misses         12       12           

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

@RemDelaporteMathurin RemDelaporteMathurin merged commit a18f695 into main Jun 11, 2024
6 checks passed
@RemDelaporteMathurin RemDelaporteMathurin deleted the documentation-guide branch July 11, 2024 11:56
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.

Add documentation building to the Developer's Guide
2 participants