Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds docs for running mkdocs locally #138

Merged
merged 1 commit into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 @@ -192,6 +192,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
Loading