Skip to content

Commit

Permalink
fix build error and update doc source map (#1831)
Browse files Browse the repository at this point in the history
* fix build error and update doc source map

* update doc build script to support git info at command level
  • Loading branch information
erich-wang authored and troydai committed Jan 24, 2017
1 parent 8e1d2aa commit 40439f1
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 13 deletions.
8 changes: 2 additions & 6 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,8 @@ environment:

install:
- SET PATH=%PYTHON%;%PYTHON%\Scripts;%PATH%
- python -m pip install -r requirements.txt
- python -m pip install -e src/azure-cli-nspkg
- python -m pip install -e src/azure-cli-core
- python scripts/dev_setup.py
- python -m pip install sphinx
- python scripts/command_modules/install.py # Install the command modules as packages
- python -m pip install -e src/azure-cli

build_script:
- ps: |
Expand Down Expand Up @@ -50,7 +46,7 @@ build_script:
- cd %TEMP%\azure-cli-xml2yml
- nuget install azure.cli.doc.xml2yml -Source https://ci.appveyor.com/nuget/azure-docs-cli-pre-process
- cd azure.cli.doc.xml2yml*\tools
- AzCliDocPreprocessor -s "%APPVEYOR_BUILD_FOLDER%\doc\sphinx\_build\xml\ind.xml" -d "%TEMP%\azure-cli-xml2yml\yml-output" -r "https://github.com/%APPVEYOR_REPO_NAME%" -b "%APPVEYOR_REPO_BRANCH%" -c "%APPVEYOR_BUILD_FOLDER%\doc\sphinx\doc_commit_map.json"
- AzCliDocPreprocessor -s "%APPVEYOR_BUILD_FOLDER%\doc\sphinx\_build\xml\ind.xml" -d "%TEMP%\azure-cli-xml2yml\yml-output" -r "https://github.com/%APPVEYOR_REPO_NAME%" -b "%APPVEYOR_REPO_BRANCH%" -c "%APPVEYOR_BUILD_FOLDER%\doc\sphinx\doc_commit_map.json" -v 1

artifacts:
- path: doc\sphinx\_build
Expand Down
4 changes: 4 additions & 0 deletions doc/sphinx/azhelpgen/azhelpgen.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ def make_rst(self):
if not is_command:
top_group_name = help_file.command.split()[0] if help_file.command else 'az'
yield '{}:docsource: {}'.format(INDENT, doc_source_map[top_group_name] if top_group_name in doc_source_map else '')
else:
top_command_name = help_file.command.split()[0] if help_file.command else ''
if top_command_name in doc_source_map:
yield '{}:docsource: {}'.format(INDENT, doc_source_map[top_command_name])
yield ''

if is_command and help_file.parameters:
Expand Down
21 changes: 15 additions & 6 deletions doc/sphinx/azhelpgen/doc_source_map.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,33 @@
{
"az": "src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py",
"configure": "src/command_modules/azure-cli-configure/azure/cli/command_modules/configure/_help.py",
"feedback": "src/command_modules/azure-cli-feedback/azure/cli/command_modules/feedback/_help.py",
"login": "src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py",
"logout": "src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py",
"account": "src/command_modules/azure-cli-profile/azure/cli/command_modules/profile/_help.py",
"ad": "src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py",
"acr": "src/command_modules/azure-cli-acr/azure/cli/command_modules/acr/_help.py",
"acs": "src/command_modules/azure-cli-acs/azure/cli/command_modules/acs/_help.py",
"appservice": "src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py",
"batch": "src/command_modules/azure-cli-batch/azure/cli/command_modules/batch/_help.py",
"cloud": "src/command_modules/azure-cli-cloud/azure/cli/command_modules/cloud/_help.py",
"component": "src/command_modules/azure-cli-component/azure/cli/command_modules/component/_help.py",
"container": "src/command_modules/azure-cli-container/azure/cli/command_modules/container/_help.py",
"context": "src/command_modules/azure-cli-context/azure/cli/command_modules/context/_help.py",
"feature": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"group": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"iot": "src/command_modules/azure-cli-iot/azure/cli/command_modules/iot/_help.py",
"keyvault": "src/command_modules/azure-cli-keyvault/azure/cli/command_modules/keyvault/_help.py",
"network": "src/command_modules/azure-cli-network/azure/cli/command_modules/network/_help.py",
"redis": "src/command_modules/azure-cli-redis/azure/cli/command_modules/redis/_help.py",
"resource": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"policy": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"provider": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"tag": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"redis": "src/command_modules/azure-cli-redis/azure/cli/command_modules/redis/_help.py",
"resource": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"role": "src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py",
"ad": "src/command_modules/azure-cli-role/azure/cli/command_modules/role/_help.py",
"sql": "src/command_modules/azure-cli-sql/azure/cli/command_modules/sql/help.py",
"storage": "src/command_modules/azure-cli-storage/azure/cli/command_modules/storage/_help.py",
"tag": "src/command_modules/azure-cli-resource/azure/cli/command_modules/resource/_help.py",
"taskhelp": "src/command_modules/azure-cli-taskhelp/azure/cli/command_modules/taskhelp/_help.py",
"vm": "src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/_help.py",
"vmss": "src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/_help.py",
"appservice": "src/command_modules/azure-cli-appservice/azure/cli/command_modules/appservice/_help.py"
"vmss": "src/command_modules/azure-cli-vm/azure/cli/command_modules/vm/_help.py"
}
6 changes: 5 additions & 1 deletion doc/sphinx/cligroup/cligroup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,11 @@ class CliGroupDirective(CliBaseDirective):
)

class CliCommandDirective(CliBaseDirective):
doc_field_types = cli_field_types
doc_field_types = copy.copy(cli_field_types)
doc_field_types.append(
Field('docsource', label='Doc Source', has_arg=False,
names=('docsource', 'documentsource'))
)

class CliArgumentDirective(CliBaseDirective):
doc_field_types = copy.copy(cli_field_types)
Expand Down

0 comments on commit 40439f1

Please sign in to comment.