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 #47

Merged
merged 2 commits into from
Feb 20, 2025
Merged

Documentation #47

merged 2 commits into from
Feb 20, 2025

Conversation

romainljsimon
Copy link
Contributor

This is the first step of the big fight.

  • Creation of the first docstrings of the function, types and structs of the module
  • Creation of the documentation in docs/

To read locally the docs, go to docs/, then activate the environment.
run julia --project make.jl. This should create a local build of the docs. Then, to open in a browser, run open build/index.html

You'll then see the beautiful docs 😮

Copy link

codecov bot commented Feb 20, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
src/simulation.jl 98.21% <100.00%> (ø)

... and 2 files with indirect coverage changes

@romainljsimon romainljsimon merged commit a726226 into main Feb 20, 2025
2 checks passed
@romainljsimon romainljsimon deleted the documentation branch February 20, 2025 15:06
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