From 3b2a2184192487458ab54d64c19081ba73e9518c Mon Sep 17 00:00:00 2001 From: Christian Adams Date: Thu, 3 Aug 2023 15:50:00 -0400 Subject: [PATCH] Add note about how to find docs after building the doc site (#1512) --- docs/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 25fb2738..acae2a72 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,4 +5,6 @@ To build the AWX Operator docs locally: 1. Clone the AWX operator repository. 2. From the root directory: a. pip install --user -r docs/requirements.txt - b. mkdocs build \ No newline at end of file + b. mkdocs build + +This will create a new directory called `site/` in the root of your clone containing the index.html and static files. To view the docs in your browser, navigate there in your file explorer and double-click on the `index.html` file. This should open the docs site in your browser. \ No newline at end of file