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

Adding documentation #114

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Adding documentation #114

wants to merge 2 commits into from

Conversation

jonathf
Copy link
Collaborator

@jonathf jonathf commented Jul 22, 2024

Using Jupyter-book and autosummary to automatically generate a proper reference manual.

Using Jupyter-book and autosummary to automatically generate a proper
reference manual.
Copy link

codecov bot commented Jul 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.1%. Comparing base (7fc9070) to head (a2bea20).

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #114   +/-   ##
=====================================
  Coverage   79.1%   79.1%           
=====================================
  Files         29      29           
  Lines       1628    1629    +1     
  Branches     138     138           
=====================================
+ Hits        1288    1289    +1     
  Misses       330     330           
  Partials      10      10           
Flag Coverage Δ
binding 69.1% <ø> (ø)
python 91.4% <100.0%> (+<0.1%) ⬆️

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

docs/documentation.rst Outdated Show resolved Hide resolved
@SebMilardo SebMilardo changed the title Adding documenation Adding documentation Jul 30, 2024
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.

2 participants