Skip to content

Index Creation Bugfixes #9334

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

Merged
scbedd merged 8 commits into from
Jan 7, 2020
Merged

Index Creation Bugfixes #9334

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0dc6ea2
porting updates for azure-mgmt-web namespaces. updating index creatio…
scbedd Jan 6, 2020
2b0a2ce
removing unnecessary install of CI tools
scbedd Jan 6, 2020
15b6fb8
passing the local folder instead of a build variable
scbedd Jan 6, 2020
f2566af
updating 404ing reference to cspack tol
scbedd Jan 6, 2020
9bd6069
resolving 404ing link to powershell cmdlet function
scbedd Jan 6, 2020
9c4efff
removing pymodule index from index. no such thing!
scbedd Jan 7, 2020
ff3afd1
remove links to some standard sphinx constructs that won't stick arou…
scbedd Jan 7, 2020
0d739d7
remove reference to 404ing font
scbedd Jan 7, 2020
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
1 change: 1 addition & 0 deletions doc/sphinx/generate_doc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ def make_title(title):
# Update the code to compute this list automatically
MULTIAPI_VERSION_NAMESPACE = [
"azure.mgmt.storage",
"azure.mgmt.web",
"azure.mgmt.network",
"azure.mgmt.compute",
"azure.mgmt.containerregistry",
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Azure SDK for Python
====================

.. important:: The most part of this documentation has moved to https://docs.microsoft.com/python/azure
.. important:: You can find all of the Python on Azure documentation at https://docs.microsoft.com/python/azure

The Azure SDK for Python is a set of libraries which allow you to work on Azure for your management, runtime or data needs.

Expand Down
11 changes: 8 additions & 3 deletions doc/sphinx/package_service_mapping.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -811,11 +811,16 @@
"azure-mgmt-web": {
"category": "Management",
"namespaces": [
"azure.mgmt.web"
"azure.mgmt.web.v2015_04_01",
"azure.mgmt.web.v2015_08_01",
"azure.mgmt.web.v2016_03_01",
"azure.mgmt.web.v2016_08_01",
"azure.mgmt.web.v2016_09_01",
"azure.mgmt.web.v2018_02_01",
"azure.mgmt.web.v2018_11_01"
],
"service_name": "Web Apps"
},

"azure-servicebus": {
"category": "Client",
"service_name": "Service Bus",
Expand Down Expand Up @@ -991,7 +996,7 @@
},
"azure-mgmt-storagesync": {
"category": "Management",
"service_name": "Storage",
"service_name": "Storage Sync",
"namespaces": [
"azure.mgmt.storagesync"
]
Expand Down
9 changes: 8 additions & 1 deletion eng/pipelines/create-doc-index.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,17 @@ jobs:
inputs:
versionSpec: $(PythonVersion)

- template: eng/pipelines/templates/scripts/replace-relative-links.yml@azure-sdk-tools
parameters:
TargetFolder: $(Build.SourcesDirectory)
Copy link
Member

@weshaggard weshaggard Jan 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Out of curiosity some of the other repo's have passed . here in the context of these parameters which one is preferred?

Copy link
Member Author

@scbedd scbedd Jan 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm actually validating the build results, and I'm almost positive I'll need to add the . explicitly. Will get back to you on this.

Copy link
Member Author

@scbedd scbedd Jan 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Definitely necessary. Update pushed.

image

Copy link
Contributor

@JimSuplizio JimSuplizio Jan 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weshaggard the java repo ran into this issue back in December . On windows, it doesn't escape the backslashes correctly so we end up getting that messed up directory.

RootFolder: $(Build.SourcesDirectory)
BuildSHA: $(Build.SourceVersion)
RepoId: 'Azure/azure-sdk-for-python'

- pwsh: |
pip install -r $(Build.SourcesDirectory)/doc/sphinx/requirements.txt
python $(Build.SourcesDirectory)/doc/sphinx/generate_versioned_index.py
mkdir $(Build.ArtifactStagingDirectory)
sphinx-build -b html -c $(Build.SourcesDirectory)/doc/sphinx $(Build.SourcesDirectory)/_docs $(Build.SourcesDirectory)/_docs/html
Copy-Item -Path $(Build.SourcesDirectory)/_docs/html/* -Destination $(Build.ArtifactStagingDirectory) -Recurse -Force
displayName: 'Generate Documentation Index'

Expand Down