You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Run `main.py` to generate documentation without serving:
247
+
248
+
```bash
249
+
cd docs/src && python main.py --verbose
250
+
```
251
+
252
+
This automatically clones `tutorials/` repository and generates markdown files in `reference/` and `releasenotes/` directories without starting a web server.
253
+
254
+
### Serving Locally
255
+
256
+
Use `mkdocs serve` to automatically clone `tutorials/` and generate documentation in `reference/` and `releasenotes/` and serve the website:
257
+
258
+
```bash
259
+
cd docs && mkdocs serve
260
+
```
261
+
262
+
The site is typically available at `http://127.0.0.1:8000/deep-learning-containers/` - check the command output for the actual URL.
263
+
264
+
### Live Reload
265
+
266
+
Enable automatic reload on content changes:
267
+
268
+
```bash
269
+
mkdocs serve --livereload
270
+
```
271
+
272
+
**Note:** Live reload only detects changes to:
273
+
274
+
- Markdown file content
275
+
- `.nav.yml`content
276
+
- `mkdocs.yml`content
277
+
278
+
Live reload does **not** detect changes requiring documentation regeneration (e.g., image config YAML files, templates). To regenerate documentation, stop the server (`Ctrl+C`) and rerun `mkdocs serve`.
0 commit comments