search

spyder-ide / spyder

Official repository for Spyder - The Scientific Python Development Environment
https://www.spyder-ide.org
MIT License
8.35k stars 1.62k forks source link

Documentation for beginners? #2522

Open AlanZZhao opened 9 years ago

AlanZZhao commented 9 years ago

I'll preface by saying I'm not sure if this is the right place to ask, but is there any available documentation for beginners?

I've been using Spyder for a few weeks now and loving it, but I still feel like I'm scratching the surface of what's possible, even at a beginner level. Are there any good resources out there that provide a comprehensive intro to the features and use?

The current documentation mainly focuses on the features, but doesn't have use examples. I've only found things like:

http://www.southampton.ac.uk/~fangohr/blog/spyder-the-python-ide.html https://www.youtube.com/watch?v=A6_gh0vrZ-E

While helpful, these feel like a collection of tips and tricks, or in the case of the video, really just using Spyder to teach CS. T

For example, PyCharm has guides like:

https://www.jetbrains.com/pycharm/quickstart/ https://confluence.jetbrains.com/display/PYH/Getting+Started+with+PyCharm

These provide what feel like more comprehensive introductions to the tool.

If so, how can I contribute?

goanpeca commented 9 years ago

Thanks @AlanZZhao for your comments, the spyder development team tries hard to develop new features and fix bugs, but it is true that we could use a hand in the documentation department.

The PyCharm Quickstart guide could serve as a template for a new documentation. The projects capabilities are being worked at this moment for the release of version 3.0, so hopefully we will have a better tutorial by then.

In the mean time, how is your markdown and Restructured text knowledge :-) ?

ccordoba12 commented 9 years ago

@AlanZZhao, there's a tutorial for beginners, under the menu

Help > Spyder tutorial