File tree Expand file tree Collapse file tree 2 files changed +39
-0
lines changed
Expand file tree Collapse file tree 2 files changed +39
-0
lines changed Original file line number Diff line number Diff line change 11# docs.instructlab.ai
2+
3+ To test documentation changes locally, you'll need to install ` mkdocs ` and the relevant dependencies in your Python environment.
4+
5+ We've included a server launching script for ease of use.
6+
7+ ## Getting Started
8+
9+ 1 . Create a virtual environment for your installation.
10+
11+ ``` bash
12+ python -m venv venv-ilab-docs
13+ source venv-ilab-docs/bin/activate
14+ ```
15+
16+ 2 . Launch the server.
17+
18+ This will:
19+ * Install mkdocs
20+ * Install the PyPI dependencies
21+ * Launch the mkdocs server locally
22+
23+ ``` bash
24+ ./launch_server.sh
25+ ```
26+
27+ 3 . Visit [ https://127.0.0.1:8000/ ] ( https://127.0.0.1:8000/ ) to see your changes in the browser.
Original file line number Diff line number Diff line change 1+ #! /bin/bash
2+
3+ # You may want to activate a new virtual environment before running this script, as it will install Python dependencies.
4+
5+ pip install -U mkdocs
6+
7+ reqs=$( mkdocs get-deps)
8+
9+ echo " Installing: " $reqs
10+ pip install -U $reqs
11+
12+ echo " Starting server..."
13+ mkdocs serve
You can’t perform that action at this time.
0 commit comments