Skip to content

Commit

Permalink
Adds docs for running mkdocs locally (#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
sulochan authored Mar 11, 2024
1 parent 2b04367 commit 70254d0
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
20 changes: 20 additions & 0 deletions docs/mkdocs-howto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Working on docs locally

To work on documentation locally and preview it while developing, we can use `mkdocs serve`

Start by installing the requirements for documentation.

``` shell
pip install -r doc-requirements.txt
```

!!! tip

You may want to first create a virtualenv and install requirements in there.

Once the installation is done, run the mkdocs server locally to view your changes.

``` shell
cd genestack/
mkdocs serve
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ nav:
- Creating Networks: openstack-neutron-networks.md
- Glance Images Creation: openstack-glance-images.md
- Building Local Images: build-local-images.md
- Working Locallly With Docs: mkdocs-howto.md
- Third Party Tools:
- OSIE: extra-osie.md
- Cloud Onboarding:
Expand Down

0 comments on commit 70254d0

Please sign in to comment.