azure-cli/doc/generating_sphinx_docs.md

394 B

#How to generate the Sphinx help file output#

Set up environment

  1. Inside a Python virtual environment, run "pip install sphinx"
  2. If Az isn't set up in this virtual environment, run "python scripts\dev_setup.py" from azure-cli

Run Sphinx

  1. From azure-cli\doc\sphinx, run "make xml"

Retrieve output

  1. XML output is stored in azure-cli\doc\sphinx_build\xml\ind.xml