Opened 21 months ago
Last modified 7 weeks ago
#30500 new enhancement
Meta-ticket: document configuring IDEs and text editors
Reported by: | slelievre | Owned by: | |
---|---|---|---|
Priority: | major | Milestone: | sage-wishlist |
Component: | documentation | Keywords: | |
Cc: | gh-tobiasdiez, tkarn, chapoton | Merged in: | |
Authors: | Reviewers: | ||
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description (last modified by )
Document configuring each common IDE or text editor for using and/or developing Sage.
- CodeMirror
- Emacs with
sage-shell-mode
oremacs-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
- vi / vim (Sage wiki)
- VSCode / vscodium - #30484
and maybe others such as
- Alpha, Alphatk
- ATOM + Hydrogen
- Blender
- Eclipse
- Geany
- 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/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:
- #30501: Syntax highlighting mode for Sage syntax, aware of the syntactic sugar Sage adds to Python syntax
- #30453 - Document
sage -tox
Change History (18)
comment:1 follow-up: ↓ 6 Changed 21 months ago by
comment:2 Changed 21 months ago by
- Description modified (diff)
comment:3 Changed 21 months ago by
- Description modified (diff)
- Milestone changed from sage-9.3 to sage-wishlist
comment:4 Changed 21 months ago by
- Description modified (diff)
comment:5 Changed 21 months ago by
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 21 months ago by
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 21 months ago by
- Description modified (diff)
comment:8 Changed 21 months ago by
- Cc gh-tobiasdiez added
- Description modified (diff)
comment:10 Changed 8 weeks ago by
- Cc tkarn added
- Description modified (diff)
comment:11 Changed 7 weeks ago by
- Description modified (diff)
comment:12 in reply to: ↑ 9 Changed 7 weeks ago by
comment:13 Changed 7 weeks ago by
- Cc chapoton added
- Description modified (diff)
comment:14 Changed 7 weeks ago by
- Description modified (diff)
comment:15 Changed 7 weeks ago by
- Description modified (diff)
comment:16 Changed 7 weeks ago by
- Description modified (diff)
comment:17 Changed 7 weeks ago by
- Description modified (diff)
comment:18 Changed 7 weeks ago by
- Description modified (diff)
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.