Add documentation for Spyder-terminal plugin

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

Add documentation for Spyder-terminal plugin #271

Closed vinisalazar closed 3 years ago

vinisalazar commented 3 years ago

Hi, I'm coming from the SciPy 2021 and this is my first contribution to the Spyder docs.

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

Add doc/img/terminal directory and corresponding images
Add plugins/terminal.rst file with documentation for the Spyder-terminal plugin

Issue(s) Resolved

Closes #270

Best, V

steff456 commented 3 years ago

Hi @vinisalazar, the preferences and configurable options of the terminal is still missing.

vinisalazar commented 3 years ago

Hi @steff456, yes, I was about to comment that I couldn't get around to doing that yet. I will try to put in a commit during the weekend.

Best, Vini

vinisalazar commented 3 years ago

Hi @steff456,

Are these features only available in v1.0.0 of the plugin? I'm having trouble installing it on the same env as Spyder 4 (I'm working on the docs page for Spyder 4.x).

I was wondering if this PR could be merged as is, so a docs page for the Terminal plugin is created, even if it doesn't present all the features available in the plugin. The features can then be added later, for the docs page of Spyder 5. I will be glad to help with that in the future. @ccordoba12 @juanis2112 what do you think?

Thanks, Vini

steff456 commented 3 years ago

Hi @vinisalazar,

So, the version 1.0.0 of the plugin is compatible with Spyder 5. If you want to use the terminal with Spyder 4 then you should be installing 0.5.0. Both of the versions include the preferences section, obviously the most recent version includes a couple of extra features.

If this is the documentation for Spyder 4, please try to install spyder-terminal 0.5.0 in your machine and just add a paragraph to the docs stating the preferences section.

vinisalazar commented 3 years ago

Hi @steff456, thank you for your response. I've added a section on customizing the Terminal preferences.

Best, Vini