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.

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

Restructure the documentation sidebar #1865

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Restructure the documentation sidebar #1865

wants to merge 1 commit into from

Conversation

dana-gill
Copy link

Reference Issue

Fixes #1478

What does this implement/fix? Explain your changes.

This restructures the Core IO section of documentation sidebar. Core IO no longer exists and is replaced by the following:

  • Signals (includes load, stream, resample, and any signal generators and helper utilities)
  • Spectral representations
  • Magnitude scaling
  • Unit conversion (time, frequency)
  • Music notation
  • Pitch and tuning
  • Harmonics
  • Phase recovery
  • Miscellaneous (collects current misc + frequency range generators)

Any other comments?

This favored over #1801 since we only want to touch the __init__.py files and not add .rst files.

@dana-gill dana-gill mentioned this pull request Aug 15, 2024
Closed
9 tasks
@codecov Codecov
Copy link

codecov bot commented Aug 15, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.73%. Comparing base (8dae20c) to head (f721d6e).
Report is 19 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1865      +/-   ##
==========================================
- Coverage   98.77%   98.73%   -0.05%     
==========================================
  Files          34       35       +1     
  Lines        4666     4658       -8     
==========================================
- Hits         4609     4599      -10     
- Misses         57       59       +2
Flag Coverage Δ
unittests 98.73% <ø> (-0.05%) ⬇️

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.

@bmcfee bmcfee added the documentation Issues relating to docstrings, examples, and documentation build label Aug 15, 2024
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 Issues relating to docstrings, examples, and documentation build
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation restructuring (core submodule)
2 participants
@dana-gill @bmcfee