summary |
shortlog |
log |
commit | commitdiff |
review |
tree
raw |
patch |
inline | side by side (from parent 1:
d215d26)
It is more common to use pip without sudo.
Also, no reason to use sudo with 'mkdocs serve'.
Bug-AGL: SPEC-3778
Signed-off-by: Vasyl Vavrychuk <vasyl.vavrychuk@opensynergy.com>
Change-Id: Ic4e2b34da98b0f036c34f253c0f0aeea150db443
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25968
Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
2. Install MkDocs and rtd-dropdown theme
```sh
2. Install MkDocs and rtd-dropdown theme
```sh
- $ sudo pip install -r requirements.txt
+ $ pip install -r requirements.txt
+ Missing packages will be installed for the current user, in particular,
+ scripts will be installed to `$HOME/.local/bin`. Ensure `$HOME/.local/bin` is
+ in your `PATH` to be able to run `mkdocs` command.
+
3. Serve locally (defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/)):
```sh
3. Serve locally (defaultly rendered at [127.0.0.1:8000/](127.0.0.1:8000/)):
```sh
```
Process to **add new or edit existing** markdown files to AGL documentation:
```
Process to **add new or edit existing** markdown files to AGL documentation: