Scribd
Upload
25 views

Generating Sphinx Docs

The document outlines the steps to generate Sphinx help file output by installing Sphinx in a Python virtual environment, running make xml from the sphinx directory, and finding the XML output in the _build/xml folder.

Uploaded by

Sec About
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
25 views

Generating Sphinx Docs

The document outlines the steps to generate Sphinx help file output by installing Sphinx in a Python virtual environment, running make xml from the sphinx directory, and finding the XML output in the _build/xml folder.

Uploaded by

Sec About
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
You are on page 1/ 1

#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

You might also like