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

Re-instate documentation for lineprofiler and notebook plugins #325

Closed jitseniesen closed 2 years ago

jitseniesen commented 2 years ago

Pull Request

Pull Request Checklist

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

Description of Changes

Remove the warning in the documentation for the spyder-lineprofiler and spyder-notebook plugins that they are incompatible with Spyder 5, because this is no longer the case. Also include them both under "Plugins" in the left sidebar.

This reverts PRs #283 and #305.

Issue(s) Resolved

Fixes #324

jitseniesen commented 2 years ago

[...] he would be releasing the final update today to make Spyder Notebook fully compatible with Spyder 5, could you just make the toctree a glob like the others to automatically, and removing the outdated warning and :orphan: tag for the Spyder Notebooks doc as well?

No problem, I will wait until spyder-notebook is released and re-instate its docs.

Also, are the text and screenshots still up to date for the current version of the plugin?

They are still up to date for the line profiler plugin, but probably not for the notebook plugin. I will check when it is released.

CAM-Gerlach commented 2 years ago

Hey @ccordoba12 , any update on the timeline for Spyder-Notebooks?

@jitseniesen , if its going to delay this significantly or we want to update the screenshots before going live with the new docs, we could just go ahead and merge this and then we can implement the change for Spyder-Notebooks separately, if you think that's better.

ccordoba12 commented 2 years ago

Hey @ccordoba12 , any update on the timeline for Spyder-Notebooks?

Sorry for the delay, I just released Spyder-notebook 0.4.0. I expect for it to be available in conda-forge later today or tomorrow.

CAM-Gerlach commented 2 years ago

@jitseniesen seems like @ccordoba12 just released Spyder-Notebook 0.4.0, FYI, and at the meeting he stated that he didn't believe there were substantial UI changes that would impact the screenshots, at least of the plugins themselves (though Spyder in the background will look different, of course).

jitseniesen commented 2 years ago

Docs for the notebook plugin are now also revived.