Skip to content

Sphinx documentation #123

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Sphinx documentation #123

wants to merge 2 commits into from

Conversation

c4deszes
Copy link
Owner

@c4deszes c4deszes commented Oct 8, 2023

Brief

  • Long awaited documentation overhaul, moving away from markdown posted on Github Pages to readthedocs hosted site
  • The main focus is improving the user experience and helping contributors understand the codebase
  • This version will not completely reflect the current state of the library, but it's mainly because the functions have not been documented

Still to be done are:

  • Workflow to build the documentation, deploy it, etc.

Checklist

  • Add relevant labels to the Pull Request
  • Review test results and code coverage
    • Review snapshot test results for deviations
  • Review code changes
    • Create relevant test scenarios
    • Update examples
    • Update JSON schema
  • Update documentation
    • Update examples in README
  • Update changelog
  • Update version number

Resolves

Evidence

  • Minor code changes

@c4deszes c4deszes added the documentation Improvements or additions to documentation label Oct 8, 2023
@codecov
Copy link

codecov bot commented Oct 8, 2023 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.29%. Comparing base (f611870) to head (7ff0386).
Report is 8 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master     #123      +/-   ##
==========================================
+ Coverage   95.84%   96.29%   +0.45%     
==========================================
  Files          13       13              
  Lines        1371     1459      +88     
==========================================
+ Hits         1314     1405      +91     
+ Misses         57       54       -3
Flag Coverage Δ
3.10.0b1 96.29% <100.00%> (+0.45%) ⬆️
3.6 ?
3.7 ?
3.8 96.29% <100.00%> (+0.45%) ⬆️
3.9 96.29% <100.00%> (+0.45%) ⬆️
unittests 96.29% <100.00%> (+0.45%) ⬆️

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AttributeError: 'LinUnconditionalFrame' object has no attribute 'signals'
1 participant
@c4deszes