Meta-ticket: document configuring IDEs and text editors

[slel]

Document configuring each common IDE or text editor
for using and/or developing Sage.

• CodeMirror
• Emacs with sage-shell-mode or emacs-jupyter (Sage wiki)
• JupyterLab text editor
• PyCharm
  • Just open SAGE_ROOT as a project
  • Ask Sage question 39742: Make PyCharm recognise the Sage Python interpreter
  • Stack Overflow question 47378147: Use PyCharm (or any Windows IDE) to run SageMath scripts
  • sage-devel discussion, 2017-12: Running Sage from an IDE like PyCharm on Windows
  • Ask Sage question 38750: How to use Sage in PyCharm in Ubuntu
• Spyder (Sage wiki)
• Sublime Text
  • Stack Overflow question 36436785: Syntax highlighting for .sage in sublime
• vi / vim (Sage wiki)
• VSCode / vscodium - Document using Sage on Windows via Visual Studio Code with WSL remote #30484

and maybe others such as

• Alpha, Alphatk
• ATOM + Hydrogen
• Blender
• Eclipse
• Geany
  • http://wiki.geany.org/config/sage
  • http://docs.huihoo.com/geany/0.16/index.html#filetype-extensions
• IDLE
• Leo
• Netbeans (Sage wiki, 2010)
• PyDev
• PyScripter
• Wing
• Xcode

What to document:

• setting up syntax highlighting for .py, .pyx, .spyx, .sage files
• telling the editor or IDE to use Sage's Python
• making Sage execute fragments of code

Workflow:

• Collect info here on this Meta-ticket
• Migrate good info to the Sage developer guide in https://github.com/sagemath/sage-prod/blob/develop/src/doc/en/developer/workspace.rst, one ticket per IDE / text editor

Existing material:

• some answers to questions, or discussions,
  on Ask Sage, sage-devel, sage-support, Stack Overflow

Related:

• Define a Sage syntax highlighting #30501: Syntax highlighting mode for Sage syntax,
  aware of the syntactic sugar Sage adds to Python syntax
• GitHub applies Python syntax highlighting to .sage and .sagews files
• Request to apply Python syntax highlighting to questions tagged sage on Stack Overflow
• Document "sage -tox" #30453 - Document sage -tox
• Ask Sage question 63071: create a file with .sage extension

CC: @tobiasdiez @trevorkarn @fchapoton

Component: documentation

Issue created by migration from https://trac.sagemath.org/ticket/30500

[slel]

comment:1

Maybe this is better done on the wiki, and the wiki should have
a summary page pointing to a page for each IDE or text editor.

[seblabbe]

comment:5

Maybe the part about vim could mention :set backupcopy=yes (see #21739) to avoid issues with the attach command (well, it's in my vimrc since 2015, but I don't know if it is still needed).

[mkoeppe]

comment:6

Replying to @slel:

Maybe this is better done on the wiki, and the wiki should have
a summary page pointing to a page for each IDE or text editor.

-1 for wiki - it's unmaintainable

+1 for extending the developer documentation

[slel]

comment:9

New blog post:

• Martin Albrecht: Conda, Jupyter and Emacs

[mkoeppe]

comment:12

Replying to @slel:

New blog post:

• Martin Albrecht: Conda, Jupyter and Emacs

I've added this to https://wiki.sagemath.org/Emacs

[slel]

comment:19

Related:

• Ask Sage question 63071: create a file with .sage extension

[jhpalmieri]

comment:21

Replying to @slel:

Maybe this is better done on the wiki, and the wiki should have
a summary page pointing to a page for each IDE or text editor.

I agree with this. There are too many moving targets to keep this in the regular documentation, and crowd-sourcing it on the wiki will allow more flexibility. Anyone who is familiar with a particular editor (even including the losers those who use vi instead of emacs) can chime in as needed.