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.

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

Index Creation Bugfixes #9334

Merged
merged 8 commits into from
Jan 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions doc/sphinx/_static/css/default_overrides.css
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,11 @@

.wy-nav-content-wrap {
margin-left: 380px;
}

@font-face{
font-family:"Roboto Slab";
font-style:normal;
font-weight:400;
src:url("../fonts/RobotoSlab/roboto-slab-v7-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff2") format("woff2"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.woff") format("woff"),url("../fonts/RobotoSlab/roboto-slab-v7-regular.ttf") format("truetype")
}
1 change: 1 addition & 0 deletions doc/sphinx/generate_doc.py
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/generate_versioned_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ def write_toc_tree(categorized_menu_items):


def get_categorized_menu_items(package_names):
categorized_menu_items = {}
categorized_menu_items = {"Other": {"Client":[], "Management":[], "Other": []}}

for pkg in package_names:
# add to the categorized menu items
Expand Down
10 changes: 1 addition & 9 deletions doc/sphinx/index.rst
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 Expand Up @@ -59,14 +59,6 @@ If you encounter any bugs with the library please file an issue in the
`Issues <https://github.com/Azure/azure-sdk-for-python/issues>`__
section of the project.


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
:glob:
:caption: User Documentation
Expand Down
11 changes: 8 additions & 3 deletions doc/sphinx/package_service_mapping.json
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
4 changes: 2 additions & 2 deletions doc/sphinx/servicemanagement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,9 @@ To make a new deployment to Azure you must store the package file in a
Microsoft Azure Blob Storage account under the same subscription as the
hosted service to which the package is being uploaded. You can create a
deployment package with the `Microsoft Azure PowerShell
cmdlets <https://www.windowsazure.com/en-us/develop/php/how-to-guides/powershell-cmdlets/>`__,
cmdlets <https://docs.microsoft.com/en-us/powershell/azure/?view=azps-3.2.0>`__,
or with the `cspack commandline
tool <http://msdn.microsoft.com/en-us/library/gg432988.aspx>`__.
tool <https://docs.microsoft.com/en-us/azure/cloud-services/cloud-services-model-and-package#servicepackagecspkg>`__.

.. code:: python

Expand Down
9 changes: 8 additions & 1 deletion eng/pipelines/create-doc-index.yml
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: '.'
RootFolder: '.'
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