diff --git a/doc/conf.py b/doc/conf.py index 1acc7abe7a47..9590a3b5d97a 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -41,8 +41,12 @@ # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] +source_parsers = { + '.md': 'recommonmark.parser.CommonMarkParser', +} + # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ['.rst', '.md'] # The encoding of source files. #source_encoding = 'utf-8-sig' diff --git a/doc/index.md b/doc/index.md new file mode 100644 index 000000000000..190b02dd18ac --- /dev/null +++ b/doc/index.md @@ -0,0 +1,6 @@ + + + + + Azure SDK for Python's documentation has moved from ReadTheDocs to docs.microsoft.com. + \ No newline at end of file diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index 3fdb8db13088..000000000000 --- a/doc/index.rst +++ /dev/null @@ -1,273 +0,0 @@ -==================== -Azure SDK for Python -==================== - -.. important:: The most part of this documentation has moved to 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. - -For a more general view of Azure and Python, you can go on the `Python Developer Center for Azure `_ - -Example Usage -------------- - -This example shows: - -* Authentication on Azure using an AD in your subscription, -* Creation of a Resource Group and a Storage account, -* Upload a simple "Hello world" HTML page and gives you the URL to get it. - -.. code:: python - - from azure.common.credentials import UserPassCredentials - from azure.mgmt.resource import ResourceManagementClient - from azure.mgmt.storage import StorageManagementClient - from azure.storage import CloudStorageAccount - from azure.storage.blob.models import ContentSettings, PublicAccess - - credentials = UserPassCredentials('user@domain.com', 'my_smart_password') - subscription_id = '33333333-3333-3333-3333-333333333333' - - resource_client = ResourceManagementClient(credentials, subscription_id) - storage_client = StorageManagementClient(credentials, subscription_id) - - resource_group_name = 'my_resource_group' - storage_account_name = 'myuniquestorageaccount' - - resource_client.resource_groups.create_or_update( - resource_group_name, - { - 'location':'westus' - } - ) - - async_create = storage_client.storage_accounts.create( - resource_group_name, - storage_account_name, - { - 'location':'westus', - 'kind':'storage', - 'sku': { - 'name':'standard_ragrs' - } - } - ) - async_create.wait() - - storage_keys = storage_client.storage_accounts.list_keys(resource_group_name, storage_account_name) - storage_keys = {v.key_name: v.value for v in storage_keys.keys} - - storage_client = CloudStorageAccount(storage_account_name, storage_keys['key1']) - blob_service = storage_client.create_block_blob_service() - - blob_service.create_container( - 'mycontainername', - public_access=PublicAccess.Blob - ) - - blob_service.create_blob_from_bytes( - 'mycontainername', - 'myblobname', - b'

Hello World!

', - content_settings=ContentSettings('text/html') - ) - - print(blob_service.make_blob_url('mycontainername', 'myblobname')) - - -Installation ------------- - -Overview -^^^^^^^^ - -You can install individually each library for each Azure service: - -.. code-block:: console - - $ pip install azure-batch # Install the latest Batch runtime library - $ pip install azure-mgmt-scheduler # Install the latest Storage management library - -Preview packages can be installed using the ``--pre`` flag: - -.. code-block:: console - - $ pip install --pre azure-mgmt-compute # will install only the latest Compute Management library - -More details and information about the available libraries and their status can be found -in the :doc:`Installation Page` - -The ``azure`` meta-package -^^^^^^^^^^^^^^^^^^^^^^^^^^ - -You can also install a set of Azure libraries in a single line using the ``azure`` meta-package. Since not all packages in this meta-package are -published as stable yet, the ``azure`` meta-package is still in preview. -However, the core packages, from code quality/completeness perspectives can at this time be considered "stable" -- it will be officially labeled as such in sync with other languages as soon as possible. -We are not planning on any further major changes until then. - -Since it's a preview release, you need to use the ``--pre`` flag: - -.. code-block:: console - - $ pip install --pre azure - -or directly - -.. code-block:: console - - $ pip install azure==2.0.0rc6 - -.. important:: The azure meta-package 1.0.3 is deprecated and is not working anymore. - -Features --------- - -Azure Resource Management -^^^^^^^^^^^^^^^^^^^^^^^^^ - -All documentation of management libraries for Azure are on this website. This includes: - -* :doc:`Authorization ` : Permissions, roles and more -* :doc:`Batch` : Manage Batch accounts and applications -* :doc:`Content Delivery Network` : Profiles, endpoints creation and more -* :doc:`Cognitive Services` : Create CS accounts and more -* :doc:`Commerce - Billing API` : RateCard and Usage Billing API -* :doc:`Compute` : Create virtual machines and more -* :doc:`Data Lake Analytics` : Manage account, job, catalog and more -* :doc:`Data Lake Store` : Manage account and more -* :doc:`DevTestLabs` : Create labs and more -* :doc:`DNS` : Create DNS zone, record set and more -* :doc:`IoTHub` : Create IoTHub account and more -* :doc:`KeyVault` : Create vaults and more -* :doc:`App Service` : Create App plan, Web Apps, Logic Apps and more -* :doc:`Media Services` : Create account and more -* :doc:`Network` : Create virtual networks, network interfaces, public IPs and more -* :doc:`Notification Hubs` : Namespaces, hub creation/deletion and more -* :doc:`PowerBI Embedded` : Create account and more -* :doc:`Redis Cache` : Create cache and more -* :doc:`Resource Management`: - - * resources : create resource groups, register providers and more - * features : manage features of provider and more - * locks : manage resource group lock and more - * subscriptions : manage subscriptions and more - -* :doc:`Scheduler` : Create job collections, create job and more -* :doc:`Server Manager` : Create gateways, nodes and more -* :doc:`SQL Database` : Create servers, databases nodes and more -* :doc:`Storage` : Create storage accounts, list keys, and more -* :doc:`Traffic Manager` : Create endpoints, profiles and more - -Azure Runtime -^^^^^^^^^^^^^ - -Some documentation of data libraries are on this website. This includes: - -* :doc:`Batch` -* :doc:`Key Vault` -* :doc:`Azure Monitor` -* :doc:`Azure Active Directory Graph RBAC` -* :doc:`Service Bus` using HTTP. - - .. note:: For critical performance issue, the Service Bus team currently recommends `AMQP `_. - -These Azure services have Python data libraries which are directly hosted by the service team or are extensively documented on the Azure documentation website: - -* `Storage `_ -* `Azure Data Lake Store Filesystem `_ -* `Azure IoT Hub service and device SDKs for Python `_ -* `SQL Azure `_ -* `DocumentDB `_ -* `Application Insight `_ -* `Redis Cache `_ -* `Write an Azure WebApp in Python `_ - - -Azure Service Management -^^^^^^^^^^^^^^^^^^^^^^^^ - -.. note:: The Service Management SDK is deprecated and no more features will be added. - -This page describes the :doc:`usage and detailed features of Azure Service Management SDK`. At a glance: - - - storage accounts: create, update, delete, list, regenerate keys - - affinity groups: create, update, delete, list, get properties - - locations: list - - hosted services: create, update, delete, list, get properties - - deployment: create, get, delete, swap, change configuration, - update status, upgrade, rollback - - role instance: reboot, reimage - - discover addresses and ports for the endpoints of other role - instances in your service - - get configuration settings and access local resources - - get role instance information for current role and other role - instances - - query and set the status of the current role - -System Requirements: --------------------- - -The supported Python versions are 2.7.x, 3.3.x, 3.4.x, 3.5.x and 3.6.x -To download Python, please visit -https://www.python.org/download/ - - -We recommend Python Tools for Visual Studio as a development environment for developing your applications. Please visit http://aka.ms/python for more information. - - -Need Help?: ------------ - -Be sure to check out the Microsoft Azure `Developer Forums on Stack -Overflow `__ if you have -trouble with the provided code. - -Contribute Code or Provide Feedback: ------------------------------------- - -If you would like to become an active contributor to this project please -follow the instructions provided in `Microsoft Azure Projects -Contribution -Guidelines `__. - -If you encounter any bugs with the library please file an issue in the -`Issues `__ -section of the project. - - -Indices and tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. toctree:: - :glob: - :caption: User Documentation - - installation - quickstart_authentication - multicloud - exceptions - -.. toctree:: - :glob: - :caption: Management Documentation - - resourcemanagement* - sample_azure-mgmt-* - Service Management (Legacy) - -.. toctree:: - :glob: - :caption: Runtime Documentation - - batch - sample_azure-monitor - sample_azure-keyvault - graphrbac - servicebus - -.. include:: autorest_generated_packages.rst diff --git a/doc/requirements.txt b/doc/requirements.txt index 82133027c9eb..f28f12f7cf39 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,2 +1,3 @@ sphinx sphinx_rtd_theme +recommonmark \ No newline at end of file