Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

More instructions on sphinx generation for extensions #81

Merged
merged 4 commits into from
Feb 26, 2018
Merged

More instructions on sphinx generation for extensions #81

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44fa109
More instructions on sphinx generation for extensions
derekbekoe Feb 26, 2018
e282ebd
sub-heading
derekbekoe Feb 26, 2018
f4cc52f
help more
derekbekoe Feb 26, 2018
65d6809
minor
derekbekoe Feb 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
More instructions on sphinx generation for extensions
  • Loading branch information
@derekbekoe
derekbekoe committed Feb 26, 2018
commit 44fa1090b51aa23ec7c9fd0102064c9e3ec8bc9c
7 changes: 7 additions & 0 deletions scripts/refdoc/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`