spyder-ide / spyder-docs

Documentation for Spyder, the Scientific Python Development Environment

https://docs.spyder-ide.org

MIT License

33 stars 283 forks source link

PR: Don't show plugins in index that aren't yet compatible with Spyder 5 #283

Closed juanis2112 closed 2 years ago

juanis2112 commented 2 years ago

Pull Request

Pull Request Checklist

[ ] Read and followed this repo's Contributing Guidelines
[ ] Based your PR on the latest version of the correct branch (master or 4.x)
[ ] Checked your writing carefully for correct English spelling, grammar, etc
[ ] Described your changes and the motivation for them below
[ ] Noted what issue(s) this pull request resolves, creating one if needed

Description of Changes

Removed plugins index from docs for spyder 5 until all the plugins are migrated and compatible with Spyder 5.

Issue(s) Resolved

Fixes #

ccordoba12 commented 2 years ago

Are some of the plugins compatible yet?

Only Spyder-terminal, but I think @juanis2112's idea is to update all plugin docs at the same time.

and instead move the incompatible plugins to a comment in indexplugins.rst

That's a good idea. @juanis2112, what do you think?

CAM-Gerlach commented 2 years ago

Only Spyder-terminal, but I think @juanis2112's idea is to update all plugin docs at the same time.

Yeah, but that means that all the plugin docs are blocked on the slowest to migrate plugin, instead of being added whenever the plugin gets migrated. IMO, if and when a plugin is supported, I'd favor making its docs available immediately, with any changes necessary so that the basic instructions are accurate for Spyder 5. If doing the updated screenshots and such is the blocker, that can be deferred, as we did for the Spyder 4 docs, as its better to have working docs with slightly out of date screenshots than no docs at all, assuming the plugin is compatible.

juanis2112 commented 2 years ago

I think however you think is best is fine for me @CAM-Gerlach. Do you want to do the change?

CAM-Gerlach commented 2 years ago

Do you want to do the change?

Sure.

CAM-Gerlach commented 2 years ago

Actually, this can wait until spyder-ide/spyder-docs#299 is merged to master; should be a little easier to do it that way and rebase than merge this first and have to deal with the merge conflicts there. That's ready to go pending your approval @juanis2112 and will make these types of changes simpler in the future.

CAM-Gerlach commented 2 years ago

Rebase complete; trivial PR, preview looks good and we all agree on how we want this to look, so going ahead and merging.