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

Top of the Specpram 2.0.0rc2 documentation page not adjusting properly #323

Closed
danieltomasz opened this issue Apr 27, 2024 · 6 comments
Closed

Comments

@danieltomasz
Copy link

danieltomasz commented Apr 27, 2024

Thanks for providing new documentation page for specparam 2.0rc
https://specparam-tools.github.io/
image

There are several small regression that might need a fix - search window is 1 line below even when making the page width enough (fooof doc page works better adjusting in wide window)
image

Separate idea - would be great to have dictionary between fooof and specparam functions, sometimes is not so easy to find new name :)

@danieltomasz
Copy link
Author

danieltomasz commented Apr 27, 2024

it is possible that 2.0.0rc just take more space and together with other menu is just wider than the maximal width of the page; is there a reason you stuck with sphinx 5.3 for specparam release, or you plan to update the sphinx used for docs in the near future?
I see you might want to support older python, but maybe specpram release might be an occasion to drop older versions?

@TomDonoghue
Copy link
Member

TomDonoghue commented Apr 30, 2024

This is now fixed!

Quick notes on the the fix (for posterity):

Also, there was no reason that I was building on sphinx 5.3 other than I hadn't updated in a bit I updated sphinx / sphinx-gallery, etc, and nothing notable seems to have changed (from a quick check).

@TomDonoghue
Copy link
Member

There is a mapping between old & new names in this PR:
#205

I'm going to update the Changelog properly now and will add that information there

@TomDonoghue
Copy link
Member

@danieltomasz - I've updated the changelog to now include a proper overview of the changes in 2.0 (that I'll continue to update), and updated this on the specparam docsite, which you can see here:
https://specparam-tools.github.io/changelog.html

Since this issue is now addressed (in terms of the original issue), I'm going to close this now - but feel free to follow up (here or elsewhere) on other thoughts / topics on the 2.0 version, including the list of name updates, etc.

@danieltomasz
Copy link
Author

Great! One thing I noticed - by FOOOF.modeled_spectrum_ here https://arc.net/l/quote/fbgltigp you probably mean Spectral one :)

@TomDonoghue
Copy link
Member

Ooops, good catch! Fixed that in the changelog - it'll be updated on the site next time I push an update!

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

No branches or pull requests

2 participants