Skip to content

Commit 7e2f283

Browse files
committed
Update readme with how to build and server docs
1 parent 89245b8 commit 7e2f283

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,25 @@ or:
119119
jupyter lite serve --LiteBuildConfig.extra_http_headers=Cross-Origin-Embedder-Policy=require-corp --LiteBuildConfig.extra_http_headers=Cross-Origin-Opener-Policy=same-origin
120120
```
121121

122+
### Building the documentation
123+
124+
The project documentation includes a demo deployment, and is built on every PR so that the changes can be checked manually before merging. To build the documentation and demo locally use:
125+
126+
```bash
127+
micromamba create -f docs/environment-docs.yml
128+
micromamba activate terminal-docs
129+
pip install -v .
130+
cd docs
131+
make html
132+
```
133+
134+
To serve this locally use:
135+
136+
```bash
137+
cd _build/html
138+
python -m http.server
139+
```
140+
122141
### Packaging the extension
123142

124143
See [RELEASE](RELEASE.md)

0 commit comments

Comments
 (0)