File: generating_sphinx_docs.md

package info (click to toggle)
azure-cli 2.82.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,359,416 kB
  • sloc: python: 1,910,381; sh: 1,343; makefile: 406; cs: 145; javascript: 74; sql: 37; xml: 21
file content (14 lines) | stat: -rw-r--r-- 401 bytes parent folder | download | duplicates (4) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
#How to generate the Sphinx help file output#

## Set up environment ##

1. Inside a Python virtual environment, run "pip install sphinx==1.6.7"
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