From 551782fba81b729dc8560be208b961ce7db6c7c7 Mon Sep 17 00:00:00 2001 From: Derek Bekoe Date: Mon, 26 Feb 2018 10:06:21 -0800 Subject: [PATCH] More instructions on sphinx generation for extensions (#81) --- scripts/refdoc/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/scripts/refdoc/README.md b/scripts/refdoc/README.md index 4ed3027b121..980ba858cbb 100644 --- a/scripts/refdoc/README.md +++ b/scripts/refdoc/README.md @@ -16,3 +16,11 @@ Scripts for reference documentation generation for Azure CLI Extensions using [s ## Retrieve output ## 1. By default, the XML output is stored in `ref-doc-out-*/ind.xml` + +## Generating Sphinx output for the latest versions of all extensions in index ## + +1. Ensure the CLI is installed in your Python virtual environment. +2. Inside the Python virtual environment, run `pip install sphinx==1.7.0` +3. Set the environment variable `AZ_EXT_REF_DOC_OUT_DIR` to an empty directory that exists. +4. Run the following script to generate sphinx output for the latest versions of all extensions in the index - `python ./scripts/ci/index_ref_doc.py -v` +5. The sphinx output will be in the directory pointed to by the `AZ_EXT_REF_DOC_OUT_DIR` environment variable.