Sphinx VsCode 配置

Vscode Host 插件

# 中文
ms-ceintl.vscode-language-pack-zh-hans

# VsCode 远程
ms-vscode-remote.remote-ssh
ms-vscode-remote.remote-ssh-edit
ms-vscode.remote-explorer
ms-vscode-remote.remote-containers

# Docker
# 环境使用 docker 固化,此外文档也涉及 docker 相关内容
docker.docker
ms-azuretools.vscode-docker

# Live Server
# sphinx-autobuild 官方插件更好,调试需求保留
ritwickdey.liveserver

# Python
# Sphinx 本身为 Python 程序
ms-python.python
ms-python.vscode-pylance

# Github Actions
github.vscode-github-actions

# C 与构建
# 嵌入式程序员,和 C 难舍难分
ms-vscode.cpptools
ms-vscode.cpptools-extension-pack
ms-vscode.cpptools-themes
ms-vscode.cmake-tools
ms-vscode.makefile-tools

# Shell
# 嵌入式程序员,Shell 也必不可少
timonwong.shellcheck

# 状态栏
# 微软官方迟迟不出行数统计功能
tomoki1207.selectline-statusbar

# Git
eamodio.gitlens

# Restructuredtext
lextudio.restructuredtext
trond-snekvik.simple-rst

# AI 助手
augment.vscode-augment

Vscode DevContainer 镜像

镜像参考: https://github.com/sphinx-doc/sphinx-docker-images

GHCR 服务卡顿,建议使用南京大学的镜像服务。

docker pull ghcr.io/serial115200/memos/devcontainer_sphinx:latest

将 ghcr.io 替换为 ghcr.nju.edu.cn

docker pull ghcr.nju.edu.cn/serial115200/memos/devcontainer_sphinx:latest

Vscode DevContainer 插件

--- /home/runner/work/memos/memos/source/env/sphinx/env_sphinx_vscode_host_ext.conf
+++ /home/runner/work/memos/memos/source/env/sphinx/env_sphinx_vscode_dev_ext.conf
@@ -1,11 +1,5 @@
 # 中文
 ms-ceintl.vscode-language-pack-zh-hans
-
-# VsCode 远程
-ms-vscode-remote.remote-ssh
-ms-vscode-remote.remote-ssh-edit
-ms-vscode.remote-explorer
-ms-vscode-remote.remote-containers
 
 # Docker
 # 环境使用 docker 固化,此外文档也涉及 docker 相关内容

VsCode DevContainer 配置

{
	"name": "Sphinx",
	"image": "ghcr.io/serial115200/memos/devcontainer_sphinx:latest",
	"customizations": {
		"vscode": {
			"settings": {},
			"extensions": [
				"docker.docker",
				"eamodio.gitlens",
				"lextudio.restructuredtext",
				"ms-azuretools.vscode-docker",
				"ms-ceintl.vscode-language-pack-zh-hans",
				"ms-python.debugpy",
				"ms-python.python",
				"ms-python.vscode-pylance",
				"ms-vscode.cmake-tools",
				"ms-vscode.cpptools",
				"ms-vscode.cpptools-extension-pack",
				"ms-vscode.cpptools-themes",
				"ms-vscode.makefile-tools",
				"ritwickdey.liveserver",
				"timonwong.shellcheck",
				"tomoki1207.selectline-statusbar",
				"trond-snekvik.simple-rst",
				"github.vscode-github-actions",
				"augment.vscode-augment"
			]
		}
	},
	"mounts": [
		"type=bind,source=${localEnv:HOME}/.ssh,target=/home/vscode/.ssh,readonly"
	],
	"postStartCommand": "make livehtml"
}