Skip to content

Commit f989a01

Browse files
author
Murilo Marinho
committed
Adjusting devcontainer installation to support local mermaid graphs.
1 parent 9edc2da commit f989a01

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

.devcontainer/postCreateCommand.sh

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,9 @@ pwd
66
export PIP_BREAK_SYSTEM_PACKAGES=1
77
pip install -r docs/source/requirements.txt
88
pip install sphinx-autobuild
9-
chmod +x .devcontainer/serve_sphinx.sh
9+
chmod +x .devcontainer/serve_sphinx.sh
10+
11+
# Making mermaid graphs work
12+
sudo apt-get update
13+
sudo apt-get install -y npm
14+
npm install -g @mermaid-js/mermaid-cli

.devcontainer/serve_sphinx.sh

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
#!/bin/bash
22
set -e
33

4-
# This is expected to be run at the root of the repository
5-
sphinx-autobuild docs/source build/html
4+
# This script is expected to be run at the root of the repository.
5+
cd docs/source
6+
# sphinx-autobuild in general should be run in this directory or the mermaid configuration will not be found.
7+
sphinx-autobuild . build/html

0 commit comments

Comments
 (0)