-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Adding local launch script. * Switching from pyenv virtual env to python -m venv - whoops * Fixing link in README Signed-off-by: Olivia Buzek <[email protected]>
- Loading branch information
Showing
2 changed files
with
39 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,27 @@ | ||
# docs.instructlab.ai | ||
|
||
To test documentation changes locally, you'll need to install `mkdocs` and the relevant dependencies in your Python environment. | ||
|
||
We've included a server launching script for ease of use. | ||
|
||
## Getting Started | ||
|
||
1. Create a virtual environment for your installation. | ||
|
||
```bash | ||
python -m venv venv-ilab-docs | ||
source venv-ilab-docs/bin/activate | ||
``` | ||
|
||
2. Launch the server. | ||
|
||
This will: | ||
* Install mkdocs | ||
* Install the PyPI dependencies | ||
* Launch the mkdocs server locally | ||
|
||
```bash | ||
./launch_server.sh | ||
``` | ||
|
||
3. Visit [https://127.0.0.1:8000/](https://127.0.0.1:8000/) to see your changes in the browser. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
#!/bin/bash | ||
|
||
# You may want to activate a new virtual environment before running this script, as it will install Python dependencies. | ||
|
||
pip install -U mkdocs | ||
|
||
reqs=$(mkdocs get-deps) | ||
|
||
echo "Installing: " $reqs | ||
pip install -U $reqs | ||
|
||
echo "Starting server..." | ||
mkdocs serve |