Skip to content

Commit 6eb1d50

Browse files
committed
Add serve docs task to show documentation
1 parent e90e977 commit 6eb1d50

2 files changed

Lines changed: 24 additions & 3 deletions

File tree

dfetch.code-workspace

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,27 @@
115115
"panel": "shared"
116116
}
117117
},
118+
{
119+
"label": "Serve Docs",
120+
"type": "shell",
121+
"command": "python",
122+
"args": [
123+
"-m",
124+
"http.server"
125+
],
126+
"options": {
127+
"cwd": "${workspaceFolder}/doc/_build/html"
128+
},
129+
"group": {
130+
"kind": "none",
131+
"isDefault": false
132+
},
133+
"presentation": {
134+
"reveal": "always",
135+
"panel": "shared"
136+
},
137+
"problemMatcher": []
138+
},
118139
{
119140
"label": "Check quality (pre-commit)",
120141
"type": "shell",

doc/contributing.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ All dependencies are pre-installed and makes it easy to get started.
3333

3434
.. tip::
3535

36-
You can preview the documentation locally by running, ``python -m http.server``
37-
inside the ``doc/_build/html`` directory. Codespaces will automatically suggest to open the forwarded port
38-
to view the changes in your browser.
36+
You can preview the documentation locally by running the ``Serve Docs`` task.
37+
Codespaces will automatically suggest to open the forwarded port to view the
38+
changes in your browser.
3939

4040
Running in VSCode
4141
-----------------

0 commit comments

Comments
 (0)