Skip to content

Commit 0d3ce5e

Browse files
authored
Add instructions how to install VSCode editor (#56)
* Update `.editorconfig` * Add `.vscode/extensions.json` for workflow recommendations
1 parent a3e814e commit 0d3ce5e

6 files changed

Lines changed: 71 additions & 1 deletion

File tree

.editorconfig

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,34 @@ root = true
33

44
[*]
55
end_of_line = lf
6+
indent_size = 2
67
charset = utf-8
78
max_line_length = 99
9+
insert_final_newline = true
10+
trim_trailing_whitespace = true
11+
12+
# Markdown files
13+
[*.md]
14+
trim_trailing_whitespace = false
15+
max_line_length = off
816

9-
[*.py]
17+
# JSON files
18+
[*.json]
19+
indent_size = 2
20+
21+
# Python files
22+
[*.{py,pyi}]
1023
indent_style = space
1124
indent_size = 4
1225
trim_trailing_whitespace = true
1326
insert_final_newline = true
1427

1528
[docs/Makefile]
1629
indent_style = tab
30+
31+
[.github/workflows/*.yml]
32+
charset = utf-8
33+
indent_style = space
34+
indent_size = 2
35+
insert_final_newline = true
36+
trim_trailing_whitespace = true

.vscode/extensions.json

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
// See https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions
3+
"recommendations": [
4+
// EditorConfig extension for VS Code
5+
"editorconfig.editorconfig",
6+
// Python extension for VS Code
7+
"ms-python.python",
8+
"ms-python.vscode-python-envs",
9+
"ms-python.debugpy",
10+
// A Python language server, powered by pyrefly
11+
"meta.pyrefly",
12+
// TOML support for VS Code
13+
"tamasfe.even-better-toml",
14+
// RST/ReST linter, preview, IntelliSense and more
15+
"lextudio.restructuredtext",
16+
// support for the Ruff linter and formatter.
17+
"charliermarsh.ruff",
18+
// Improve your code commenting by annotating with alert, informational, TODOs, and more!
19+
"aaron-bond.better-comments",
20+
// Syntax highlighting for jinja(2) including HTML, Markdown etc.
21+
"samuelcolvin.jinjahtml",
22+
]
23+
}

changelog.d/56.doc.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add instructions how to install VSCode editor
14 KB
Loading

docs/source/developer/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ This guide provides all the necessary information for contributing to the projec
1616

1717
project-dependencies
1818
prepare-environment
19+
install-vscode
1920
develop-project
2021
run-testsuite
2122
update-package
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _install-vscode:
2+
3+
Installing Visual Studio Code Editor
4+
====================================
5+
6+
Visual Studio Code (VSCode) is a popular code editor that can be customized for Python development. Basically you can use any editor you like, but VSCode
7+
is supported by this project.
8+
9+
Follow these steps to set up VSCode for working with this project:
10+
11+
#. Install Visual Studio Code
12+
13+
Download and install VSCode from the official website: https://code.visualstudio.com/
14+
15+
#. Install the recommended extensions
16+
17+
Open VSCode and go to the Extensions view by clicking on the Extensions icon.
18+
In the text field, enter ``@recommended`` to see the list of recommended extensions for this project.
19+
20+
#. Click the cloud icon next to the :guilabel:`Workspace Recommendations` header to `install all recommended extensions <https://code.visualstudio.com/docs/configure/extensions/extension-marketplace#_workspace-recommended-extensions>`_.
21+
22+
Alternatively, you can install the extensions one by one by clicking on the install button next to each extension.
23+
24+
.. image:: img/vscode-install-ext.png
25+
:alt: VSCode Extensions view with highlighted cloud icon

0 commit comments

Comments
 (0)