Skip to content

Commit

Permalink
More instructions on sphinx generation for extensions (#81)
Browse files Browse the repository at this point in the history
  • Loading branch information
derekbekoe authored Feb 26, 2018
1 parent 141b7db commit 551782f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions scripts/refdoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 551782f

Please sign in to comment.