From 44fa1090b51aa23ec7c9fd0102064c9e3ec8bc9c Mon Sep 17 00:00:00 2001 From: Derek Bekoe Date: Mon, 26 Feb 2018 09:57:57 -0800 Subject: [PATCH 1/4] More instructions on sphinx generation for extensions --- scripts/refdoc/README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/scripts/refdoc/README.md b/scripts/refdoc/README.md index 4ed3027b121..7feface0630 100644 --- a/scripts/refdoc/README.md +++ b/scripts/refdoc/README.md @@ -16,3 +16,10 @@ 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 version 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` From e282ebd4518d8345310ac45fba0aef0bffb08724 Mon Sep 17 00:00:00 2001 From: Derek Bekoe Date: Mon, 26 Feb 2018 09:59:18 -0800 Subject: [PATCH 2/4] sub-heading --- scripts/refdoc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/refdoc/README.md b/scripts/refdoc/README.md index 7feface0630..8a08637239d 100644 --- a/scripts/refdoc/README.md +++ b/scripts/refdoc/README.md @@ -17,7 +17,7 @@ Scripts for reference documentation generation for Azure CLI Extensions using [s 1. By default, the XML output is stored in `ref-doc-out-*/ind.xml` -# Generating Sphinx output for the latest version of all extensions in index # +## Generating Sphinx output for the latest version 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` From f4cc52ff684a6801600ff0045fbf5a99c1255878 Mon Sep 17 00:00:00 2001 From: Derek Bekoe Date: Mon, 26 Feb 2018 10:01:04 -0800 Subject: [PATCH 3/4] help more --- scripts/refdoc/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/refdoc/README.md b/scripts/refdoc/README.md index 8a08637239d..cb0f09d731b 100644 --- a/scripts/refdoc/README.md +++ b/scripts/refdoc/README.md @@ -23,3 +23,4 @@ Scripts for reference documentation generation for Azure CLI Extensions using [s 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. From 65d6809cf5fc00585ed6f26c09ca210e26d5c298 Mon Sep 17 00:00:00 2001 From: Derek Bekoe Date: Mon, 26 Feb 2018 10:02:03 -0800 Subject: [PATCH 4/4] minor --- scripts/refdoc/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/refdoc/README.md b/scripts/refdoc/README.md index cb0f09d731b..980ba858cbb 100644 --- a/scripts/refdoc/README.md +++ b/scripts/refdoc/README.md @@ -17,7 +17,7 @@ Scripts for reference documentation generation for Azure CLI Extensions using [s 1. By default, the XML output is stored in `ref-doc-out-*/ind.xml` -## Generating Sphinx output for the latest version of all extensions in index ## +## 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`