Opened 2 years ago

Last modified 3 months ago

#30500 new enhancement

Meta-ticket: document configuring IDEs and text editors — at Version 8

Reported by: Samuel Lelièvre Owned by:
Priority: major Milestone: sage-wishlist
Component: documentation Keywords:
Cc: Tobias Diez, Trevor Karn, Frédéric Chapoton Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description (last modified by Matthias Köppe)

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

  • CodeMirror
  • Emacs + sage-shell-mode
  • JupyterLab text editor
  • PyCharm
  • Spyder
  • Sublime Text
  • vi / vim
  • VSCode / vscodium - #30484

and maybe others such as

  • Alpha, Alphatk
  • ATOM + Hydrogen
  • Blender
  • Eclipse
  • IDLE
  • Leo
  • 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

Maybe one ticket per IDE or text editor?

Existing material:

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

Related:

  • #30501: Syntax highlighting mode for Sage syntax, aware of the syntactic sugar Sage adds to Python syntax

Change History (8)

comment:1 Changed 2 years ago by Samuel Lelièvre

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.

comment:2 Changed 2 years ago by Samuel Lelièvre

Description: modified (diff)

comment:3 Changed 2 years ago by Samuel Lelièvre

Description: modified (diff)
Milestone: sage-9.3sage-wishlist

comment:4 Changed 2 years ago by Matthias Köppe

Description: modified (diff)

comment:5 Changed 2 years ago by Sébastien Labbé

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).

comment:6 in reply to:  1 Changed 2 years ago by Matthias Köppe

Replying to slelievre:

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

comment:7 Changed 2 years ago by Samuel Lelièvre

Description: modified (diff)

comment:8 Changed 2 years ago by Matthias Köppe

Cc: Tobias Diez added
Description: modified (diff)
Note: See TracTickets for help on using tickets.